ContactGroupServices.BeginAddContact Method (String, ContactAddOptions, AsyncCallback, Object)
Begins an asynchronous operation to add a contact.
Namespace: Microsoft.Rtc.Collaboration.ContactsGroups
Assembly: Microsoft.Rtc.Collaboration (in Microsoft.Rtc.Collaboration.dll)
Syntax
'Declaration
Public Function BeginAddContact ( _
contactUri As String, _
options As ContactAddOptions, _
userCallback As AsyncCallback, _
state As Object _
) As IAsyncResult
'Usage
Dim instance As ContactGroupServices
Dim contactUri As String
Dim options As ContactAddOptions
Dim userCallback As AsyncCallback
Dim state As Object
Dim returnValue As IAsyncResult
returnValue = instance.BeginAddContact(contactUri, _
options, userCallback, state)
public IAsyncResult BeginAddContact(
string contactUri,
ContactAddOptions options,
AsyncCallback userCallback,
Object state
)
Parameters
- contactUri
Type: System.String
URI of the contact being added.
- options
Type: Microsoft.Rtc.Collaboration.ContactsGroups.ContactAddOptions
Optional parameters when creating a contact.
- userCallback
Type: System.AsyncCallback
The method to be called when the asynchronous operation is completed.
- state
Type: System.Object
A user-provided object that distinguishes this particular asynchronous operation from other asynchronous operations.
Return Value
Type: System.IAsyncResult
An IAsyncResult that references the asynchronous operation.
Exceptions
| Exception | Condition |
|---|---|
| InvalidOperationException | Thrown when the subscription state is not idle or subscribed. |
| ArgumentException | Thrown when contactUri is an invalid sip URI. |
| ArgumentNullException | Thrown when optionsare null. |
| ArgumentOutOfRangeException | Thrown when any of options.GroupIds is negative. |
Remarks
If the endpoint is operating in privacy mode then an Access Control Entry will automatically be added to the endpoint owner's Access Control lists or containers. The notifications if this operation is successful can be obtained by wiring ContainerNotificationReceived.