MSFT_SIPESUserContactGroupData

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

Defines the settings for a contact group that is associated with a specific Office Communications Server 2007 R2 user.

MSFT_SIPESUserContactGroupData

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_SIPESUserContactGroupData
{
  string ExternalURL;
  [key] uint32 GroupID;
  string Name;
  [key] string UserInstanceID;
};

Methods

This class does not define any methods.

Properties

The MSFT_SIPESUserContactGroupData class has the following properties.

  • ExternalURL
    Data type: string

    Access type: Read/Write

    Optional. An external URL for this contact group.

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

  • GroupID
    Data type: [key] uint32

    Access type: Read-only

    Optional. The contact group ID as an integer value between 1 and 64.

    This value must be unique for the Active Directory user, such that no other group associated with the user has the same ID. This value has to be NULL for create operations (the server generates this value), and it cannot be NULL for update operations. When an instance is created, the property can no longer be changed. The appropriate flags must be used (as specified in the Remarks section).

    This group ID is present in the GroupID array property of MSFT_SIPESUserContactData, which contains a list of all groups the user participates in. A maximum of 64 contact groups is supported.

  • Name
    Data type: string

    Access type: Read/Write

    Required. The display name for this contact group.

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

  • UserInstanceID
    Data type: [key] string

    Access type: Read-only

    Required. A GUID value that uniquely identifies the Active Directory user with which this contact group is associated.

    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 group is a specific collection of contacts defined by a user. Each contact is represented by an instance of the MSFT_SIPESUserContactData class.

To perform operations on this class, connect to 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.

Uniqueness of a class instance is guaranteed by a combination of the group ID and the GUID that represents the Active Directory user.

Instances of this class support the following interface methods:

  • Provider::DeleteInstance();

  • Provider::PutInstance();

    Where PutInstance() supports the following flag:

    • WBEM_FLAG_CREATE_ONLY

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_SIPESUserContactData

Office Communications Server WMI Reference