IUccSubscriber.Acknowledged Property

  • Article

This content is no longer actively maintained. It is provided as is, for anyone who may still be using these technologies, with no warranties or claims of accuracy with regard to the most recent product version or service release.

Gets and sets the flag indicating whether this subscriber is already acknowledged.

Namespace: Microsoft.Office.Interop.UccApi
Assembly: Microsoft.Office.Interop.UccApi (in microsoft.office.interop.uccapi.dll)

Syntax

'Declaration
Property Acknowledged As Boolean

bool Acknowledged { get; set; }

property bool Acknowledged {
    bool get ();
    void set (bool value);
}

/** @property */
boolean get_Acknowledged ()

/** @property */
void set_Acknowledged (boolean value)

function get Acknowledged () : boolean

function set Acknowledged (value : boolean)

Property Value

A value of the VARIANT_BOOL* (bool, for a .NET application) type. This returns TRUE if this subscriber is already acknowledged and FALSE if not.

Remarks

The IUccSubscriber interface provides a client application with the Uri, source network, and acknowledgement status of a remote user's subscription request. It is important to note that this interface does not give the local user the ability to block a subscription.

The properties of the IUccSubscriber interface should be used to present the local user with a UI dialog informing the local user of the remote subscription and presenting the user with an opportunity to create a corresponding subscription. The client should set the Acknowledged flag to True after the local user has responded to the dialog. This flag can be used to prevent or allow the client to display the UI dialog. An application can set this property to TRUE to avoid repeatedly notifying the local user of further subscription requests made by this subscriber.

Win32 COM/C++ Syntax

HRESULT get_Acknowledged
(
   VARIANT_BOOL* pfAcknowledged
);
HRESULT put_Acknowledged
(
   VARIANT_BOOL pfAcknowledged
);

Note

In a Win32 application, the return value of a method or property is always an HRESULT value indicating the status of the call to the interface member. Any result of the operation is returned as a parameter marked with the [out, retval] attribute. In contrast, in a .NET application the HRESULT value indicating an error condition is returned as a COM exception and the [out, retval] parameter becomes the return value. For the UCC API-defined HRESULT values, see Trace and Handle Errors in Unified Communications Client API.

Example

The following example code snippet from the event handler example found in IUccSubscriber reads the Acknowledged property to conditionally prompt a user to add the subscribing user as a contact.

if (subscribingUser.Acknowledged == false)
{
   // prompt user
}

Thread Safety

All public static (Shared in Visual Basic) members of this type are thread-safe. Instance members are not guaranteed to be thread-safe.

Platforms

Development Platforms

Windows XP Professional with Service Pack 2 (SP2), Windows Server 2000 with Service Pack 4, Windows Server 2003, Windows Vista Ultimate Edition, Windows Vista Business Edition, Windows Vista Enterprise Edition

Target Platforms

See Also

Reference

IUccSubscriber Interface
IUccSubscriber Members
Microsoft.Office.Interop.UccApi Namespace