Begins an asynchronous operation to add a contact.

Namespace:  Microsoft.Rtc.Collaboration.ContactsGroups
Assembly:  Microsoft.Rtc.Collaboration(in Microsoft.Rtc.Collaboration.dll)

Syntax

Visual Basic (Declaration) 
Public 
Function 
BeginAddContact ( _
	
contactUri 
As 
String, _
	
contactName 
As 
String, _
	
isSubscribed 
As 
Boolean, _
	
contactData 
As 
String, _
	
contactExtension 
As 
String, _
	
groupIds 
As 
Integer(), _
	
userCallback 
As 
AsyncCallback, _
	
state 
As 
Object _
) 
As 
IAsyncResult
C# 
public 
IAsyncResult 
BeginAddContact(
	
string 
contactUri,
	
string 
contactName,
	
bool 
isSubscribed,
	
string 
contactData,
	
string 
contactExtension,
	
int[] 
groupIds,
	
AsyncCallback 
userCallback,
	
Object 
state
)
Visual C++ 
public:
IAsyncResult^ 
BeginAddContact(
	
String^ 
contactUri, 
	
String^ 
contactName, 
	
bool 
isSubscribed, 
	
String^ 
contactData, 
	
String^ 
contactExtension, 
	
array<
int>^ 
groupIds, 
	
AsyncCallback^ 
userCallback, 
	
Object^ 
state
)
JavaScript 
function 
beginAddContact(
contactUri, 
contactName, 
isSubscribed, 
contactData, 
contactExtension, 
groupIds, 
userCallback, 
state);

Parameters

contactUri
Type: String
URI of the contact being added.
contactName
Type: String
Name of the contact being added.
isSubscribed
Type: Boolean
True, if this contact also needs to be subscribed.
contactData
Type: String
ContactData.
contactExtension
Type: String
ContactExtension data needs to be published with this contact.
groupIds
Type: array< Int32 > [] () []
List of GroupIds where this contact would be added.
userCallback
Type: AsyncCallback
The method to be called when the asynchronous operation is completed.
state
Type: Object
A user-provided object that distinguishes this particular asynchronous operation from other asynchronous operations.

Return Value

An IAsyncResult that references the asynchronous operation.

Exceptions

Exception Condition
ArgumentOutOfRangeException Thrown when any of the groupIdsare less than zero.
InvalidOperationException Thrown when the subscription state is not idle or subscribed.
ArgumentException Thrown when contactUriis an invalid sip URI.
ArgumentNullException Thrown when contactNameor contactDataare null.

See Also