Options
All
  • Public
  • Public/Protected
  • All
Menu

@azure/communication-network-traversal

Package version

Index

Type aliases

CommunicationNetworkTraversalIssueRelayConfigurationResponse

CommunicationNetworkTraversalIssueRelayConfigurationResponse: CommunicationRelayConfiguration & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: CommunicationRelayConfiguration } }

Contains response data for the issueRelayConfiguration operation.

RouteType

RouteType: "any" | "nearest"

Defines values for RouteType.

Variables

Const SDK_VERSION

SDK_VERSION: string = "1.0.0-beta.1"

Const logger

logger: any = createClientLogger("communication-network-traversal")

The @azure/logger configuration for this package.

Const packageName

packageName: "azure-communication-network-traversal" = "azure-communication-network-traversal"

Const packageVersion

packageVersion: "package-2021-10-08-preview" = "package-2021-10-08-preview"

Const serializer

serializer: any = new coreHttp.Serializer(Mappers, /* isXml */ false)

Functions

Const isCommunicationRelayClientOptions

  • isCommunicationRelayClientOptions(options: any): options is CommunicationRelayClientOptions

Object literals

Const CommunicationError

CommunicationError: object

type

type: object

className

className: string = "CommunicationError"

name

name: string = "Composite"

modelProperties

modelProperties: object

code

code: object

required

required: boolean = true

serializedName

serializedName: string = "code"

type

type: object

name

name: string = "String"

details

details: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "details"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "CommunicationError"

name

name: string = "Composite"

innerError

innerError: object

serializedName

serializedName: string = "innererror"

type

type: object

className

className: string = "CommunicationError"

name

name: string = "Composite"

message

message: object

required

required: boolean = true

serializedName

serializedName: string = "message"

type

type: object

name

name: string = "String"

target

target: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "target"

type

type: object

name

name: string = "String"

Const CommunicationErrorResponse

CommunicationErrorResponse: object

type

type: object

className

className: string = "CommunicationErrorResponse"

name

name: string = "Composite"

modelProperties

modelProperties: object

error

error: object

serializedName

serializedName: string = "error"

type

type: object

className

className: string = "CommunicationError"

name

name: string = "Composite"

Const CommunicationIceServer

CommunicationIceServer: object

type

type: object

className

className: string = "CommunicationIceServer"

name

name: string = "Composite"

modelProperties

modelProperties: object

credential

credential: object

required

required: boolean = true

serializedName

serializedName: string = "credential"

type

type: object

name

name: string = "String"

routeType

routeType: object

required

required: boolean = true

serializedName

serializedName: string = "routeType"

type

type: object

name

name: string = "String"

urls

urls: object

required

required: boolean = true

serializedName

serializedName: string = "urls"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

username

username: object

required

required: boolean = true

serializedName

serializedName: string = "username"

type

type: object

name

name: string = "String"

Const CommunicationRelayConfiguration

CommunicationRelayConfiguration: object

type

type: object

className

className: string = "CommunicationRelayConfiguration"

name

name: string = "Composite"

modelProperties

modelProperties: object

expiresOn

expiresOn: object

required

required: boolean = true

serializedName

serializedName: string = "expiresOn"

type

type: object

name

name: string = "DateTime"

iceServers

iceServers: object

required

required: boolean = true

serializedName

serializedName: string = "iceServers"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "CommunicationIceServer"

name

name: string = "Composite"

Const CommunicationRelayConfigurationRequest

CommunicationRelayConfigurationRequest: object

type

type: object

className

className: string = "CommunicationRelayConfigurationRequest"

name

name: string = "Composite"

modelProperties

modelProperties: object

id

id: object

serializedName

serializedName: string = "id"

type

type: object

name

name: string = "String"

routeType

routeType: object

serializedName

serializedName: string = "routeType"

type

type: object

name

name: string = "String"

Const apiVersion

apiVersion: object

parameterPath

parameterPath: string = "apiVersion"

mapper

mapper: object

defaultValue

defaultValue: string = "2021-10-08-preview"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "api-version"

type

type: object

name

name: string = "String"

Const body

body: object

mapper

mapper: any = CommunicationRelayConfigurationRequestMapper

parameterPath

parameterPath: Object = ["options", "body"]

Const contentType

contentType: object

parameterPath

parameterPath: Object = ["options", "contentType"]

mapper

mapper: object

defaultValue

defaultValue: string = "application/json"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "Content-Type"

type

type: object

name

name: string = "String"

Const endpoint

endpoint: object

parameterPath

parameterPath: string = "endpoint"

skipEncoding

skipEncoding: boolean = true

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "endpoint"

type

type: object

name

name: string = "String"

Const issueRelayConfigurationOperationSpec

issueRelayConfigurationOperationSpec: object

headerParameters

headerParameters: Object = [Parameters.contentType]

httpMethod

httpMethod: string = "POST"

mediaType

mediaType: string = "json"

path

path: string = "/networktraversal/:issueRelayConfiguration"

queryParameters

queryParameters: Object = [Parameters.apiVersion]

requestBody

requestBody: any = Parameters.body

serializer

serializer: any

urlParameters

urlParameters: Object = [Parameters.endpoint]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.CommunicationRelayConfiguration

default

default: object

bodyMapper

bodyMapper: any = Mappers.CommunicationErrorResponse

Generated using TypeDoc