SupportsMethod
This documentation is archived and is not being maintained.

SupportsMethod

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.

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

Syntax

bool SupportsMethod(
  string or StandardHeader value methodName,
  integer standardMethods,
  string extraMethods
);

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

Show:
© 2016 Microsoft