Share via


UserEndpointPresenceServices.BeginUpdatePresenceState Method

Begins an asynchronous operation to publish the user or endpoint presence state.

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

Syntax

'Declaration
Public Function BeginUpdatePresenceState ( _
    newState As PresenceState, _
    userCallback As AsyncCallback, _
    state As Object _
) As IAsyncResult
'Usage
Dim instance As UserEndpointPresenceServices
Dim newState As PresenceState
Dim userCallback As AsyncCallback
Dim state As Object
Dim returnValue As IAsyncResult

returnValue = instance.BeginUpdatePresenceState(newState, _
    userCallback, state)
public IAsyncResult BeginUpdatePresenceState(
    PresenceState newState,
    AsyncCallback userCallback,
    Object state
)

Parameters

  • 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 endpoint is not in the "registered" state, or the current state of LocalOwnerPresence is not "subscribed".

ArgumentNullException

Thrown when newState passed is null.

ArgumentException

Thrown when newState is not of type UserState or EndpointState.

See Also

Reference

UserEndpointPresenceServices Class

UserEndpointPresenceServices Members

Microsoft.Rtc.Collaboration Namespace

UserAvailable

UserBusy

UserDoNotDisturb

UserBeRightBack

UserAway

UserOffline

EndpointOnline

EndpointAway

EndpointIdle