SupportsMethod(string or StandardHeader value,integer,string) function

Microsoft Office Live Communications Server 2005 with SP1

SupportsMethod

The SupportsMethod function determines whether a specific SIP method is supported by the application.

boolSupportsMethod(string or StandardHeader valuemethodName,
integerstandardMethods,
stringextraMethods);

Parameters

  • methodName
    The method name whose support will be determined. This parameter can contain either a string with the method name, or a member of the StandardMethod enumeration.

  • standardMethods
    A bit mask that contains all standard SIP methods supported by the application. This mask is a logical OR operation that uses zero or more of the following values.

    REGISTER
    SUBSCRIBE
    NOTIFY
    ACK
    BYE
    INVITE
    OPTIONS
    MESSAGE
    SERVICE
    INFO
    REFER

  • extraMethods
    A comma-separated list of nonstandard SIP method names. These custom method names are not defined in the current SIP specification and are application-specific.

Return Values

Returns true if methodName is present in either standardMethods or extraMethods, or if both parameters are empty. Otherwise, if methodName is an empty string or contains a comma, it returns false.

Remarks

This function is useful for determining if the standard and extra (custom) methods defined for an endpoint support the current request method. For example, an endpoint may support only "REGISTER" and "SUBSCRIBE", in which case this function returns false when the current request method is an "INVITE".

What did you think of this topic?
© 2008 Microsoft Corporation. All rights reserved.