MSFT_SIPApplicationContactSetting (New)

  • 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 SIP endpoints that represent applications.

MSFT_SIPApplicationContactSetting

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_SIPApplicationContactSetting
{
  boolean AllowOrganizeMeetingWithAnonymousParticipants;
  string ApplicationDestinationDN;
  boolean ArchiveFederatedCommunications;
  boolean ArchiveInternalCommunications;
  string ContactDN;
  string DisplayName;
  string DisplayNumber;
  boolean Enabled;
  boolean EnabledForEnhancedPresence;
  boolean EnabledForFederation;
  string HomeServerDN;
  [key] string InstanceID;
  string LineURI;
  string LocationProfile;
  string MeetingPolicy;
  string PresencePolicy;
  uint32 PrimaryLanguage;
  string PrimaryURI;
  boolean PublicNetworkEnabled;
  uint32[] SecondaryLanguages;
  string TargetServerDNIfMoving;
  boolean UCEnabled;
  string UCPolicy;
};

Methods

This class does not define any methods.

Properties

The MSFT_SIPApplicationContactSetting class has the following properties.

  • AllowOrganizeMeetingWithAnonymousParticipants
    Data type: boolean

    Access type: Read/Write

    Optional. Controls whether the user is permitted to organize meetings that include anonymous participants.

  • ApplicationDestinationDN
    Data type: string

    Access type: Read/Write

    Optional. Specifies the distinguished name of the trusted service instance for the pool.

    The value of this property is not case-sensitive.

  • ArchiveFederatedCommunications
    Data type: boolean

    Access type: Read/Write

    Optional. Controls whether a user's communications across federated domains are archived.

    The default value is False.

  • ArchiveInternalCommunications
    Data type: boolean

    Access type: Read/Write

    Optional. Controls whether a user's communications within the internal domain are archived.

    The default value is False.

  • ContactDN
    Data type: string

    Access type: Read-only

    Optional. The distinguished name of the contact.

    The value of this property is not case-sensitive.

  • DisplayName
    Data type: string

    Access type: Read/Write

    Optional. The display name for this user as registered on the home server.

    The value can be NULL, but if specified, it must be the actual display name of the user as specified in Active Directory (both for create and update operations). The value of this property is not case-sensitive.

  • DisplayNumber
    Data type: string

    Access type: Read/Write

    Optional. The telephone number that is displayed in the address book.

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

  • Enabled
    Data type: boolean

    Access type: Read/Write

    Required. If True, this user is enabled for Office Communications Server; if False, the user does not have specific support under SIP.

    The default value is True.

  • EnabledForEnhancedPresence
    Data type: boolean

    Access type: Read/Write

    Optional. Controls whether the user is enabled for enhanced presence.

    When using WMI to enable new users whose client is Office Communicator 2007 R2, this property must be set to True to enable them to log on to Office Communications Server 2007 R2.

    After this property is set to True for a user, it is not possible to set this property back to False for that user. An attempt to set this property from True to False for a user returns an error.

    The default value is True.

  • EnabledForFederation
    Data type: boolean

    Access type: Read/Write

    Optional. Controls whether the user is enabled for federation.

    The default value is False.

  • HomeServerDN
    Data type: string

    Access type: Read/Write

    Optional. The distinguished name of the Office Communications Server pool or server for this user.

    This name must be valid within the domain's Active Directory. The value of this property is not case-sensitive.

  • InstanceID
    Data type: [key] string

    Access type: Read-only

    Optional. A GUID value that uniquely identifies an instance of this class.

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

  • LineURI
    Data type: string

    Access type: Read/Write

    Optional. The device ID (either the SIP URI or the TEL URI of the user's phone line) used by Microsoft Office Communicator for telephony.

    This value is used by the Microsoft Office Communicator client and by Enterprise Voice for call routing.

    A valid SIP URI uses the following form: sip:+14255550100@phones.fabrikam.com;user=phone This SIP URI value must be unique.

    A valid Tel. The URI uses the following form: +14255550111;ext=50111;attribute=telephone number

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

  • LocationProfile
    Data type: string

    Access type: Read/Write

    Optional. The distinguished name of the location profile assigned to the user.

    The value of this property is not case-sensitive.

    The default value is NULL.

  • MeetingPolicy
    Data type: string

    Access type: Read/Write

    Optional. Specifies the distinguished name of the meeting policy that applies to the user.

    The value of this property is not case-sensitive.

    The default value is NULL.

  • PresencePolicy
    Data type: string

    Access type: Read/Write

    Optional. Specifies the distinguished name of the presence policy that applies to the user.

    The value of this property is not case-sensitive.

  • PrimaryLanguage
    Data type: uint32

    Access type: Read/Write

    Optional. Specifies the National Language Support (NLS) locale ID (LCID) value that corresponds to the primary language for the application contact.

    LCID values are four-character hexadecimal values. Leading zeros do not need to be included as part of the LanguageID value. For example, the CWA server recognizes the LanguageID value 9 as equivalent to the LCID value 0009 (English). Use only the values that correspond to the languages that CWA server is designed to support. See the NLS Information Page for a list of LCID values.

    The minimum value for this property is 0 and the maximum value is 1048576.

  • PrimaryURI
    Data type: string

    Access type: Read/Write

    Required. The primary SIP URI of the endpoint.

    A valid SIP URI uses the following form, where "sipdomain" represents the default domain for the pool in which the contact is homed: sip:unique_id@sipdomain.

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

  • PublicNetworkEnabled
    Data type: boolean

    Access type: Read/Write

    Optional. Controls whether the user is able to exchange instant messages with other users who are hosted by one or more public IM service providers.

    The default value is False.

  • SecondaryLanguages
    Data type: uint32[]

    Access type: Read/Write

    Optional. An array that specifies National Language Support (NLS) locale ID (LCID) values that correspond to secondary languages for the application contact.

    LCID values are four-character hexadecimal values. Leading zeros do not need to be included as part of the LanguageID value. For example, the CWA server recognizes the LanguageID value 9 as equivalent to the LCID value 0009 (English). Use only the values that correspond to the languages that CWA server is designed to support. See the NLS Information Page for a list of LCID values.

    The minimum value for this property is 0 and the maximum value is 1048576.

  • TargetServerDNIfMoving
    Data type: string

    Access type: Read-only

    Optional. The distinguished name of the target Standard Edition server or Enterprise Edition pool to which the Active Directory user object is moving. This value is specified when a move from one Office Communications Server or pool to another is in progress.

    The value of this property is not case-sensitive.

  • UCEnabled
    Data type: boolean

    Access type: Read/Write

    Optional. Controls whether the user is enabled for Enterprise Voice (VoIP).

    The default value is True.

  • UCPolicy
    Data type: string

    Access type: Read/Write

    Optional. Specifies the distinguished name of the Unified Communications (UC) policy that applies to the user.

    The value of this property is not case-sensitive.

Remarks

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

Instances of this class support the following interface methods:

  • Provider::DeleteInstance();

  • Provider::EnumerateInstances();

  • Provider::GetObject();

  • Provider::PutInstance();

    Where PutInstance() supports the following flags:

    • WBEM_FLAG_CREATE_ONLY

    • WBEM_FLAG_UPDATE_ONLY

    • WBEM_FLAG_CREATE_OR_UPDATE

Requirements

Server: Installed on computers serving the following roles: Administrative Tools Server, Application Host, Communicator Web Access Server, Front End Server, Proxy Server, and Web Components Server.

Namespace: Defined in \root\cimv2.

See Also

Concepts

Office Communications Server WMI Reference