Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Channels

Package version

Class representing a Channels.

Hierarchy

  • Channels

Index

Constructors

Methods

Constructors

constructor

Methods

create

  • create(resourceGroupName: string, resourceName: string, channelName: Models.ChannelName, parameters: BotChannel, options?: msRest.RequestOptionsBase): Promise<Models.ChannelsCreateResponse>
  • create(resourceGroupName: string, resourceName: string, channelName: Models.ChannelName, parameters: BotChannel, callback: msRest.ServiceCallback<BotChannel>): void
  • create(resourceGroupName: string, resourceName: string, channelName: Models.ChannelName, parameters: BotChannel, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<BotChannel>): void

  • Creates a Channel registration for a Bot Service

    Parameters

    • resourceGroupName: string

      The name of the Bot resource group in the user subscription.

    • resourceName: string

      The name of the Bot resource.

    • channelName: Models.ChannelName

      The name of the Channel resource. Possible values include: 'FacebookChannel', 'EmailChannel', 'KikChannel', 'TelegramChannel', 'SlackChannel', 'MsTeamsChannel', 'SkypeChannel', 'WebChatChannel', 'DirectLineChannel', 'SmsChannel'

    • parameters: BotChannel

      The parameters to provide for the created bot.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.ChannelsCreateResponse>

    Promise<Models.ChannelsCreateResponse>

  • Parameters

    • resourceGroupName: string

      The name of the Bot resource group in the user subscription.

    • resourceName: string

      The name of the Bot resource.

    • channelName: Models.ChannelName

      The name of the Channel resource. Possible values include: 'FacebookChannel', 'EmailChannel', 'KikChannel', 'TelegramChannel', 'SlackChannel', 'MsTeamsChannel', 'SkypeChannel', 'WebChatChannel', 'DirectLineChannel', 'SmsChannel'

    • parameters: BotChannel

      The parameters to provide for the created bot.

    • callback: msRest.ServiceCallback<BotChannel>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      The name of the Bot resource group in the user subscription.

    • resourceName: string

      The name of the Bot resource.

    • channelName: Models.ChannelName

      The name of the Channel resource. Possible values include: 'FacebookChannel', 'EmailChannel', 'KikChannel', 'TelegramChannel', 'SlackChannel', 'MsTeamsChannel', 'SkypeChannel', 'WebChatChannel', 'DirectLineChannel', 'SmsChannel'

    • parameters: BotChannel

      The parameters to provide for the created bot.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<BotChannel>

      The callback

    Returns void

deleteMethod

  • deleteMethod(resourceGroupName: string, resourceName: string, channelName: string, options?: msRest.RequestOptionsBase): Promise<msRest.RestResponse>
  • deleteMethod(resourceGroupName: string, resourceName: string, channelName: string, callback: msRest.ServiceCallback<void>): void
  • deleteMethod(resourceGroupName: string, resourceName: string, channelName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<void>): void

  • Deletes a Channel registration from a Bot Service

    Parameters

    • resourceGroupName: string

      The name of the Bot resource group in the user subscription.

    • resourceName: string

      The name of the Bot resource.

    • channelName: string

      The name of the Bot resource.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRest.RestResponse>

    Promise<msRest.RestResponse>

  • Parameters

    • resourceGroupName: string

      The name of the Bot resource group in the user subscription.

    • resourceName: string

      The name of the Bot resource.

    • channelName: string

      The name of the Bot resource.

    • callback: msRest.ServiceCallback<void>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      The name of the Bot resource group in the user subscription.

    • resourceName: string

      The name of the Bot resource.

    • channelName: string

      The name of the Bot resource.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<void>

      The callback

    Returns void

get

  • get(resourceGroupName: string, resourceName: string, channelName: string, options?: msRest.RequestOptionsBase): Promise<Models.ChannelsGetResponse>
  • get(resourceGroupName: string, resourceName: string, channelName: string, callback: msRest.ServiceCallback<BotChannel>): void
  • get(resourceGroupName: string, resourceName: string, channelName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<BotChannel>): void

  • Returns a BotService Channel registration specified by the parameters.

    Parameters

    • resourceGroupName: string

      The name of the Bot resource group in the user subscription.

    • resourceName: string

      The name of the Bot resource.

    • channelName: string

      The name of the Bot resource.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.ChannelsGetResponse>

    Promise<Models.ChannelsGetResponse>

  • Parameters

    • resourceGroupName: string

      The name of the Bot resource group in the user subscription.

    • resourceName: string

      The name of the Bot resource.

    • channelName: string

      The name of the Bot resource.

    • callback: msRest.ServiceCallback<BotChannel>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      The name of the Bot resource group in the user subscription.

    • resourceName: string

      The name of the Bot resource.

    • channelName: string

      The name of the Bot resource.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<BotChannel>

      The callback

    Returns void

listByResourceGroup

  • listByResourceGroup(resourceGroupName: string, resourceName: string, options?: msRest.RequestOptionsBase): Promise<Models.ChannelsListByResourceGroupResponse>
  • listByResourceGroup(resourceGroupName: string, resourceName: string, callback: msRest.ServiceCallback<ChannelResponseList>): void
  • listByResourceGroup(resourceGroupName: string, resourceName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<ChannelResponseList>): void

  • Returns all the Channel registrations of a particular BotService resource

    Parameters

    • resourceGroupName: string

      The name of the Bot resource group in the user subscription.

    • resourceName: string

      The name of the Bot resource.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.ChannelsListByResourceGroupResponse>

    Promise<Models.ChannelsListByResourceGroupResponse>

  • Parameters

    • resourceGroupName: string

      The name of the Bot resource group in the user subscription.

    • resourceName: string

      The name of the Bot resource.

    • callback: msRest.ServiceCallback<ChannelResponseList>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      The name of the Bot resource group in the user subscription.

    • resourceName: string

      The name of the Bot resource.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<ChannelResponseList>

      The callback

    Returns void

listByResourceGroupNext

  • listByResourceGroupNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.ChannelsListByResourceGroupNextResponse>
  • listByResourceGroupNext(nextPageLink: string, callback: msRest.ServiceCallback<ChannelResponseList>): void
  • listByResourceGroupNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<ChannelResponseList>): void

  • Returns all the Channel registrations of a particular BotService resource

    Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.ChannelsListByResourceGroupNextResponse>

    Promise<Models.ChannelsListByResourceGroupNextResponse>

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • callback: msRest.ServiceCallback<ChannelResponseList>

      The callback

    Returns void

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<ChannelResponseList>

      The callback

    Returns void

listWithKeys

  • listWithKeys(resourceGroupName: string, resourceName: string, channelName: Models.ChannelName, options?: msRest.RequestOptionsBase): Promise<Models.ChannelsListWithKeysResponse>
  • listWithKeys(resourceGroupName: string, resourceName: string, channelName: Models.ChannelName, callback: msRest.ServiceCallback<BotChannel>): void
  • listWithKeys(resourceGroupName: string, resourceName: string, channelName: Models.ChannelName, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<BotChannel>): void

  • Lists a Channel registration for a Bot Service including secrets

    Parameters

    • resourceGroupName: string

      The name of the Bot resource group in the user subscription.

    • resourceName: string

      The name of the Bot resource.

    • channelName: Models.ChannelName

      The name of the Channel resource. Possible values include: 'FacebookChannel', 'EmailChannel', 'KikChannel', 'TelegramChannel', 'SlackChannel', 'MsTeamsChannel', 'SkypeChannel', 'WebChatChannel', 'DirectLineChannel', 'SmsChannel'

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.ChannelsListWithKeysResponse>

    Promise<Models.ChannelsListWithKeysResponse>

  • Parameters

    • resourceGroupName: string

      The name of the Bot resource group in the user subscription.

    • resourceName: string

      The name of the Bot resource.

    • channelName: Models.ChannelName

      The name of the Channel resource. Possible values include: 'FacebookChannel', 'EmailChannel', 'KikChannel', 'TelegramChannel', 'SlackChannel', 'MsTeamsChannel', 'SkypeChannel', 'WebChatChannel', 'DirectLineChannel', 'SmsChannel'

    • callback: msRest.ServiceCallback<BotChannel>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      The name of the Bot resource group in the user subscription.

    • resourceName: string

      The name of the Bot resource.

    • channelName: Models.ChannelName

      The name of the Channel resource. Possible values include: 'FacebookChannel', 'EmailChannel', 'KikChannel', 'TelegramChannel', 'SlackChannel', 'MsTeamsChannel', 'SkypeChannel', 'WebChatChannel', 'DirectLineChannel', 'SmsChannel'

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<BotChannel>

      The callback

    Returns void

update

  • update(resourceGroupName: string, resourceName: string, channelName: Models.ChannelName, options?: Models.ChannelsUpdateOptionalParams): Promise<Models.ChannelsUpdateResponse>
  • update(resourceGroupName: string, resourceName: string, channelName: Models.ChannelName, callback: msRest.ServiceCallback<BotChannel>): void
  • update(resourceGroupName: string, resourceName: string, channelName: Models.ChannelName, options: ChannelsUpdateOptionalParams, callback: msRest.ServiceCallback<BotChannel>): void

  • Updates a Channel registration for a Bot Service

    Parameters

    • resourceGroupName: string

      The name of the Bot resource group in the user subscription.

    • resourceName: string

      The name of the Bot resource.

    • channelName: Models.ChannelName

      The name of the Channel resource. Possible values include: 'FacebookChannel', 'EmailChannel', 'KikChannel', 'TelegramChannel', 'SlackChannel', 'MsTeamsChannel', 'SkypeChannel', 'WebChatChannel', 'DirectLineChannel', 'SmsChannel'

    • Optional options: Models.ChannelsUpdateOptionalParams

    Returns Promise<Models.ChannelsUpdateResponse>

    Promise<Models.ChannelsUpdateResponse>

  • Parameters

    • resourceGroupName: string

      The name of the Bot resource group in the user subscription.

    • resourceName: string

      The name of the Bot resource.

    • channelName: Models.ChannelName

      The name of the Channel resource. Possible values include: 'FacebookChannel', 'EmailChannel', 'KikChannel', 'TelegramChannel', 'SlackChannel', 'MsTeamsChannel', 'SkypeChannel', 'WebChatChannel', 'DirectLineChannel', 'SmsChannel'

    • callback: msRest.ServiceCallback<BotChannel>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      The name of the Bot resource group in the user subscription.

    • resourceName: string

      The name of the Bot resource.

    • channelName: Models.ChannelName

      The name of the Channel resource. Possible values include: 'FacebookChannel', 'EmailChannel', 'KikChannel', 'TelegramChannel', 'SlackChannel', 'MsTeamsChannel', 'SkypeChannel', 'WebChatChannel', 'DirectLineChannel', 'SmsChannel'

    • options: ChannelsUpdateOptionalParams

      The optional parameters

    • callback: msRest.ServiceCallback<BotChannel>

      The callback

    Returns void

Generated using TypeDoc