MSFT_SIPESUserContactData

  • 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.

Specifies a contact for an Office Communications Server user.

MSFT_SIPESUserContactData

The following syntax is simplified from Managed Object Format (MOF) code and includes all inherited properties. Properties are listed in alphabetic order, not MOF order.

Syntax

class MSFT_SIPESUserContactData
{
  string ExternalURL;
  uint32[] GroupID;
  string Name;
  [key] string SIPURI;
  boolean Subscribed;
  [key] string UserInstanceID;
};

Methods

This class does not define any methods.

Properties

The MSFT_SIPESUserContactData class has the following properties.

  • ExternalURL
    Data type: string

    Access type: Read/Write

    Optional. The external URL for this contact.

    The value of this property is not case-sensitive. The maximum length of the string is 2048 characters.

  • GroupID
    Data type: uint32[]

    Access type: Read/Write

    Optional. An array of ID values for the contact groups of which this contact is a member.

    Each element must contain a unique ID between 1 and 64. The maximum array size is 64.

  • Name
    Data type: string

    Access type: Read/Write

    Optional. The display name for this contact.

    The value of this property is not case-sensitive. The maximum length of the string is 256 characters.

  • SIPURI
    Data type: [key] string

    Access type: Read-only

    Required. The valid SIP URI of the contact.

    The value of this property is not case-sensitive. The maximum length of the string is 454 characters.

  • Subscribed
    Data type: boolean

    Access type: Read/Write

    Required. Specifies whether the user is subscribed to this contact.

    If True, the user is subscribed to this contact. If False, the user is not subscribed to this contact.

  • UserInstanceID
    Data type: [key] string

    Access type: Read-only

    Required. A GUID value that uniquely identifies the Active Directory user subscribing to this contact.

    The GUID must be encapsulated between the "{" and "}" braces; for example: "{01234567-0123-4567-89AB-CDEF01234567}".

Remarks

This class gets and sets information at the following level: USERDCOM.

A contact is the representation of a SIP user in the context of presence updates; that is, it is the view of one SIP user by another user who has subscribed to the first user and requested availability information about it. A contact has zero or more contact groups to which it belongs. The settings for a contact group are represented by the MSFT_SIPESUserContactGroupData class.

To perform operations on this class, connect to the local WMI. In turn, WMI contacts the home server of the user and retrieves or updates the data for the instance of this class associated with the user. Office Communications Server must be running and available on the user's home server.

Note

Using WMI to create instances of MSFT_SIPESUserContactData requires clients to sign off and sign on again to see the new contacts.

Uniqueness is guaranteed by a combination of the GUID that represents the Active Directory user and the SIP URI.

Instances of this class support the following interface methods:

  • Provider::DeleteInstance();

  • Provider::PutInstance();

    Where PutInstance() supports the following flag:

    • WBEM_FLAG_CREATE_OR_UPDATE

Requirements

Server: Installed on computers serving the following roles: Administrative Tools Server, Front End Server, and Proxy Server.

Namespace: Defined in \root\cimv2.

See Also

Concepts

MSFT_SIPESUserContactGroupData

Office Communications Server WMI Reference