MSFT_SIPESUserContactData class

Article
11/13/2008

Microsoft Office Live Communications Server 2005 with SP1

MSFT_SIPESUserContactData

The MSFT_SIPESUserContactData class defines the data associated with a contact.

The following syntax is simplified from MOF code and includes all inherited properties.

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

The external URL for this contact. The maximum length of the string is 2,048 characters.

This property is optional on creation and can be updated.
GroupID
Data type: uint32[]

An array of ID values for the contact groups that this contact is a member of. This property can be NULL. Each element must contain a unique ID between 1 and 64. The maximum array size is 64.

This property is optional on creation and can be updated.
Name
Data type: string

The display name for this contact. This name can be no more than 256 characters.

This property is optional on creation and can be updated.
SIPURI
Data type: [key] string

The valid SIP URI of the contact. The maximum length of the string is 454 characters.

This property is required on creation and cannot be updated.
Subscribed
Data type: boolean

If true, the user is subscribed to this contact. If false, it is not.

This property is required on creation and can be updated.
UserInstanceID
Data type: [key] string

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}".

This property is required on creation and cannot be updated.

Remarks

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 is represented by the MSFT_SIPESUserContactGroupData class. For PutInstance operations only WBEM_FLAG_CREATE_OR_UPDATE flag is supported

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. Live 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 in order to see the new contacts.

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

Available actions for an instance of this class:

Creation: A member of the "Live Communications Domain User Admins" group can create instances of this class.
Updates: A member of the "Live Communications Domain User Admins" group can update instances of this class.
Deletion: A member of the "Live Communications Domain User Admins" group can delete instances of this class.

Requirements

Server: Installed on Windows Server 2003 with Live Communications Server 2005 with SP1.
Namespace: Defined in \root\cimv2.

Share via