LocalOwnerPresence.BeginPublishPresence Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
BeginPublishPresence(ICollection<PresenceCategory>, AsyncCallback, Object) |
Begins an asynchronous operation to publish a given list of categories. |
BeginPublishPresence(ICollection<PresenceCategoryWithMetaData>, AsyncCallback, Object) |
Begins an asynchronous operation to publish a given list of categories. |
BeginPublishPresence(ICollection<PresenceCategory>, AsyncCallback, Object)
Begins an asynchronous operation to publish a given list of categories.
public:
IAsyncResult ^ BeginPublishPresence(System::Collections::Generic::ICollection<Microsoft::Rtc::Collaboration::Presence::PresenceCategory ^> ^ categoryItems, AsyncCallback ^ userCallback, System::Object ^ state);
public IAsyncResult BeginPublishPresence (System.Collections.Generic.ICollection<Microsoft.Rtc.Collaboration.Presence.PresenceCategory> categoryItems, AsyncCallback userCallback, object state);
member this.BeginPublishPresence : System.Collections.Generic.ICollection<Microsoft.Rtc.Collaboration.Presence.PresenceCategory> * AsyncCallback * obj -> IAsyncResult
Public Function BeginPublishPresence (categoryItems As ICollection(Of PresenceCategory), userCallback As AsyncCallback, state As Object) As IAsyncResult
Parameters
- categoryItems
- ICollection<PresenceCategory>
The list of categoryItems
to be published.
- userCallback
- AsyncCallback
The method to be called when the asynchronous operation is completed.
- state
- Object
A user-provided object that distinguishes this particular asynchronous operation from other asynchronous operations.
Returns
An IAsyncResult that references the asynchronous operation.
Exceptions
Thrown when the endpoint is not in the "registered" state, or the current state of LocalOwnerPresence is not "subscribed" or at least one of the categories to be published is unknown.
Thrown when categoryItems
passed is null.
Thrown when categoryItems
contains a null CategoryItem or a custom category with invalid xml or transformation.
Remarks
Only UserEndpoints can use this API which uses a grammar provided by UCMA to publish. ApplicationEndpoints have to explicitly specify the container ID and instance ID for their publication.
UserEndpoints must already have subscribed to LocalOwnerPresence session before they can use this Api.
Applies to
BeginPublishPresence(ICollection<PresenceCategoryWithMetaData>, AsyncCallback, Object)
Begins an asynchronous operation to publish a given list of categories.
public:
IAsyncResult ^ BeginPublishPresence(System::Collections::Generic::ICollection<Microsoft::Rtc::Collaboration::Presence::PresenceCategoryWithMetaData ^> ^ categories, AsyncCallback ^ userCallback, System::Object ^ state);
public IAsyncResult BeginPublishPresence (System.Collections.Generic.ICollection<Microsoft.Rtc.Collaboration.Presence.PresenceCategoryWithMetaData> categories, AsyncCallback userCallback, object state);
member this.BeginPublishPresence : System.Collections.Generic.ICollection<Microsoft.Rtc.Collaboration.Presence.PresenceCategoryWithMetaData> * AsyncCallback * obj -> IAsyncResult
Public Function BeginPublishPresence (categories As ICollection(Of PresenceCategoryWithMetaData), userCallback As AsyncCallback, state As Object) As IAsyncResult
Parameters
- categories
- ICollection<PresenceCategoryWithMetaData>
The list of categories to be published.
- userCallback
- AsyncCallback
The method to be called when the asynchronous operation is completed.
- state
- Object
A user-provided object that distinguishes this particular asynchronous operation from other asynchronous operations.
Returns
An IAsyncResult that references the asynchronous operation.
Exceptions
Thrown when the endpoint is not in the "registered" state.
Thrown when categories
is null.
Thrown when categories
contains a null CategoryItem.
Remarks
Deleting a publication involves publishing the PresenceCategoryWithMetaData object again with the ExpiryPolicy set to Time and Expires set to the value zero.