Options
All
  • Public
  • Public/Protected
  • All
Menu

@azure/communication-administration

Package version

Index

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

CommunicationIdentityCreateResponse

CommunicationIdentityCreateResponse: CommunicationIdentity & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: CommunicationIdentity } }

Contains response data for the create operation.

CommunicationIdentityIssueTokenResponse

CommunicationIdentityIssueTokenResponse: CommunicationIdentityToken & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: CommunicationIdentityToken } }

Contains response data for the issueToken operation.

CreateUserResponse

CreateUserResponse: WithResponse<CommunicationUser>

Represents the response from creating a user

IssueTokenResponse

IssueTokenResponse: WithResponse<CommunicationUserToken>

Represents the response from issuing a token

OperationTracingOptions

OperationTracingOptions: OperationOptions["tracingOptions"]

TokenScope

TokenScope: "chat" | "voip" | "pstn"

Represents the scope of the token.

VoidResponse

VoidResponse: WithResponse<{}>

Represents a generic HTTP response

WithResponse

WithResponse<T>: T & { _response: HttpResponse }

Represents an object with a non-enumerable _response property which provides information about the HTTP response.

Type parameters

  • T

Variables

Const SDK_VERSION

SDK_VERSION: string = apiVersion.mapper.defaultValue

Const logger

logger: any = createClientLogger("communication-administration")

The @azure/logger configuration for this package.

Const packageName

packageName: "azure-communication-administration-identity" = "azure-communication-administration-identity"

Const packageVersion

packageVersion: "1.0.0-beta.1" = "1.0.0-beta.1"

Const serializer

serializer: any = new coreHttp.Serializer(Mappers)

Functions

Const attachHttpResponse

  • attachHttpResponse<T>(model: T, httpResponse: any | HttpOperationResponse): WithResponse<T>

  • Attach http response to a model

    Type parameters

    • T

    Parameters

    • model: T
    • httpResponse: any | HttpOperationResponse

    Returns WithResponse<T>

Const isCommunicationIdentityOptions

  • isCommunicationIdentityOptions(options: any): options is CommunicationIdentityOptions

Object literals

Const CommunicationIdentity

CommunicationIdentity: object

serializedName

serializedName: string = "CommunicationIdentity"

type

type: object

className

className: string = "CommunicationIdentity"

name

name: string = "Composite"

modelProperties

modelProperties: object

id

id: object

required

required: boolean = true

serializedName

serializedName: string = "id"

type

type: object

name

name: string = "String"

Const CommunicationIdentityToken

CommunicationIdentityToken: object

serializedName

serializedName: string = "CommunicationIdentityToken"

type

type: object

className

className: string = "CommunicationIdentityToken"

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"

id

id: object

required

required: boolean = true

serializedName

serializedName: string = "id"

type

type: object

name

name: string = "String"

token

token: object

required

required: boolean = true

serializedName

serializedName: string = "token"

type

type: object

name

name: string = "String"

Const CommunicationIdentityUpdateRequest

CommunicationIdentityUpdateRequest: object

serializedName

serializedName: string = "CommunicationIdentityUpdateRequest"

type

type: object

className

className: string = "CommunicationIdentityUpdateRequest"

name

name: string = "Composite"

modelProperties

modelProperties: object

tokensValidFrom

tokensValidFrom: object

serializedName

serializedName: string = "tokensValidFrom"

type

type: object

name

name: string = "DateTime"

Const CommunicationTokenRequest

CommunicationTokenRequest: object

serializedName

serializedName: string = "CommunicationTokenRequest"

type

type: object

className

className: string = "CommunicationTokenRequest"

name

name: string = "Composite"

modelProperties

modelProperties: object

scopes

scopes: object

required

required: boolean = true

serializedName

serializedName: string = "scopes"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

Const apiVersion

apiVersion: object

parameterPath

parameterPath: string = "apiVersion"

mapper

mapper: object

defaultValue

defaultValue: string = "2020-07-20-preview2"

isConstant

isConstant: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "api-version"

type

type: object

name

name: string = "String"

Const createOperationSpec

createOperationSpec: object

httpMethod

httpMethod: string = "POST"

path

path: string = "identities"

queryParameters

queryParameters: Object = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: Object = [Parameters.endpoint]

responses

responses: object

default

default: {}

Type declaration

200

200: object

bodyMapper

bodyMapper: any = Mappers.CommunicationIdentity

Const deleteMethodOperationSpec

deleteMethodOperationSpec: object

httpMethod

httpMethod: string = "DELETE"

path

path: string = "identities/{id}"

queryParameters

queryParameters: Object = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: Object = [Parameters.endpoint, Parameters.id]

responses

responses: object

204

204: {}

Type declaration

default

default: {}

Type declaration

Const endpoint

endpoint: object

parameterPath

parameterPath: string = "endpoint"

skipEncoding

skipEncoding: boolean = true

mapper

mapper: object

defaultValue

defaultValue: string = ""

required

required: boolean = true

serializedName

serializedName: string = "endpoint"

type

type: object

name

name: string = "String"

Const id

id: object

parameterPath

parameterPath: string = "id"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "id"

type

type: object

name

name: string = "String"

Const issueTokenOperationSpec

issueTokenOperationSpec: object

httpMethod

httpMethod: string = "POST"

path

path: string = "identities/{id}/token"

queryParameters

queryParameters: Object = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: Object = [Parameters.endpoint, Parameters.id]

requestBody

requestBody: object

mapper

mapper: object

required

required: boolean = true

parameterPath

parameterPath: object

scopes

scopes: string = "scopes"

responses

responses: object

default

default: {}

Type declaration

200

200: object

bodyMapper

bodyMapper: any = Mappers.CommunicationIdentityToken

Const updateOperationSpec

updateOperationSpec: object

contentType

contentType: string = "application/merge-patch+json"

httpMethod

httpMethod: string = "PATCH"

path

path: string = "identities/{id}"

queryParameters

queryParameters: Object = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: Object = [Parameters.endpoint, Parameters.id]

requestBody

requestBody: object

mapper

mapper: object

required

required: boolean = true

parameterPath

parameterPath: object

tokensValidFrom

tokensValidFrom: Object = ["options", "tokensValidFrom"]

responses

responses: object

204

204: {}

Type declaration

default

default: {}

Type declaration

Generated using TypeDoc