channel

package
v0.20240923.1151247 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 23, 2024 License: MPL-2.0 Imports: 11 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/botservice/2022-09-15/channel Documentation

The channel SDK allows for interaction with Azure Resource Manager botservice (API Version 2022-09-15).

This readme covers example usages, but further information on using this SDK can be found in the project root.

Import Path

import "github.com/hashicorp/go-azure-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/botservice/2022-09-15/channel"

Client Initialization

client := channel.NewChannelClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ChannelClient.Create

ctx := context.TODO()
id := commonids.NewBotServiceChannelID("12345678-1234-9876-4563-123456789012", "example-resource-group", "botServiceName", "AcsChatChannel")

payload := channel.BotChannel{
	// ...
}


read, err := client.Create(ctx, id, payload)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: ChannelClient.Delete

ctx := context.TODO()
id := commonids.NewBotServiceChannelID("12345678-1234-9876-4563-123456789012", "example-resource-group", "botServiceName", "AcsChatChannel")

read, err := client.Delete(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: ChannelClient.DirectLineRegenerateKeys

ctx := context.TODO()
id := commonids.NewBotServiceChannelID("12345678-1234-9876-4563-123456789012", "example-resource-group", "botServiceName", "AcsChatChannel")

payload := channel.SiteInfo{
	// ...
}


read, err := client.DirectLineRegenerateKeys(ctx, id, payload)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: ChannelClient.EmailCreateSignInUrl

ctx := context.TODO()
id := commonids.NewBotServiceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "botServiceName")

read, err := client.EmailCreateSignInUrl(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: ChannelClient.Get

ctx := context.TODO()
id := commonids.NewBotServiceChannelID("12345678-1234-9876-4563-123456789012", "example-resource-group", "botServiceName", "AcsChatChannel")

read, err := client.Get(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: ChannelClient.ListByResourceGroup

ctx := context.TODO()
id := commonids.NewBotServiceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "botServiceName")

// alternatively `client.ListByResourceGroup(ctx, id)` can be used to do batched pagination
items, err := client.ListByResourceGroupComplete(ctx, id)
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: ChannelClient.ListWithKeys

ctx := context.TODO()
id := commonids.NewBotServiceChannelID("12345678-1234-9876-4563-123456789012", "example-resource-group", "botServiceName", "AcsChatChannel")

read, err := client.ListWithKeys(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: ChannelClient.Update

ctx := context.TODO()
id := commonids.NewBotServiceChannelID("12345678-1234-9876-4563-123456789012", "example-resource-group", "botServiceName", "AcsChatChannel")

payload := channel.BotChannel{
	// ...
}


read, err := client.Update(ctx, id, payload)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForBotServiceChannelType

func PossibleValuesForBotServiceChannelType() []string

func PossibleValuesForEmailChannelAuthMethod

func PossibleValuesForEmailChannelAuthMethod() []int64

func PossibleValuesForKey

func PossibleValuesForKey() []string

func PossibleValuesForKind

func PossibleValuesForKind() []string

func PossibleValuesForSkuName

func PossibleValuesForSkuName() []string

func PossibleValuesForSkuTier

func PossibleValuesForSkuTier() []string

Types

type AcsChatChannel

type AcsChatChannel struct {
	ChannelName       string  `json:"channelName"`
	Etag              *string `json:"etag,omitempty"`
	Location          *string `json:"location,omitempty"`
	ProvisioningState *string `json:"provisioningState,omitempty"`
}

func (AcsChatChannel) Channel added in v0.20240920.1135249

func (s AcsChatChannel) Channel() BaseChannelImpl

func (AcsChatChannel) MarshalJSON

func (s AcsChatChannel) MarshalJSON() ([]byte, error)

type AlexaChannel

type AlexaChannel struct {
	Properties *AlexaChannelProperties `json:"properties,omitempty"`

	ChannelName       string  `json:"channelName"`
	Etag              *string `json:"etag,omitempty"`
	Location          *string `json:"location,omitempty"`
	ProvisioningState *string `json:"provisioningState,omitempty"`
}

func (AlexaChannel) Channel added in v0.20240920.1135249

func (s AlexaChannel) Channel() BaseChannelImpl

func (AlexaChannel) MarshalJSON

func (s AlexaChannel) MarshalJSON() ([]byte, error)

type AlexaChannelProperties

type AlexaChannelProperties struct {
	AlexaSkillId       string  `json:"alexaSkillId"`
	IsEnabled          bool    `json:"isEnabled"`
	ServiceEndpointUri *string `json:"serviceEndpointUri,omitempty"`
	UrlFragment        *string `json:"urlFragment,omitempty"`
}

type BaseChannelImpl added in v0.20240920.1135249

type BaseChannelImpl struct {
	ChannelName       string  `json:"channelName"`
	Etag              *string `json:"etag,omitempty"`
	Location          *string `json:"location,omitempty"`
	ProvisioningState *string `json:"provisioningState,omitempty"`
}

func (BaseChannelImpl) Channel added in v0.20240920.1135249

func (s BaseChannelImpl) Channel() BaseChannelImpl

type BotChannel

type BotChannel struct {
	Etag       *string            `json:"etag,omitempty"`
	Id         *string            `json:"id,omitempty"`
	Kind       *Kind              `json:"kind,omitempty"`
	Location   *string            `json:"location,omitempty"`
	Name       *string            `json:"name,omitempty"`
	Properties Channel            `json:"properties"`
	Sku        *Sku               `json:"sku,omitempty"`
	Tags       *map[string]string `json:"tags,omitempty"`
	Type       *string            `json:"type,omitempty"`
	Zones      *zones.Schema      `json:"zones,omitempty"`
}

func (*BotChannel) UnmarshalJSON

func (s *BotChannel) UnmarshalJSON(bytes []byte) error

type BotChannelOperationPredicate

type BotChannelOperationPredicate struct {
	Etag     *string
	Id       *string
	Location *string
	Name     *string
	Type     *string
}

func (BotChannelOperationPredicate) Matches

func (p BotChannelOperationPredicate) Matches(input BotChannel) bool

type BotServiceChannelType

type BotServiceChannelType string
const (
	BotServiceChannelTypeAcsChatChannel          BotServiceChannelType = "AcsChatChannel"
	BotServiceChannelTypeAlexaChannel            BotServiceChannelType = "AlexaChannel"
	BotServiceChannelTypeDirectLineChannel       BotServiceChannelType = "DirectLineChannel"
	BotServiceChannelTypeDirectLineSpeechChannel BotServiceChannelType = "DirectLineSpeechChannel"
	BotServiceChannelTypeEmailChannel            BotServiceChannelType = "EmailChannel"
	BotServiceChannelTypeFacebookChannel         BotServiceChannelType = "FacebookChannel"
	BotServiceChannelTypeKikChannel              BotServiceChannelType = "KikChannel"
	BotServiceChannelTypeLineChannel             BotServiceChannelType = "LineChannel"
	BotServiceChannelTypeM365Extensions          BotServiceChannelType = "M365Extensions"
	BotServiceChannelTypeMsTeamsChannel          BotServiceChannelType = "MsTeamsChannel"
	BotServiceChannelTypeOmnichannel             BotServiceChannelType = "Omnichannel"
	BotServiceChannelTypeOutlookChannel          BotServiceChannelType = "OutlookChannel"
	BotServiceChannelTypeSearchAssistant         BotServiceChannelType = "SearchAssistant"
	BotServiceChannelTypeSkypeChannel            BotServiceChannelType = "SkypeChannel"
	BotServiceChannelTypeSlackChannel            BotServiceChannelType = "SlackChannel"
	BotServiceChannelTypeSmsChannel              BotServiceChannelType = "SmsChannel"
	BotServiceChannelTypeTelegramChannel         BotServiceChannelType = "TelegramChannel"
	BotServiceChannelTypeTelephonyChannel        BotServiceChannelType = "TelephonyChannel"
	BotServiceChannelTypeWebChatChannel          BotServiceChannelType = "WebChatChannel"
)

func (*BotServiceChannelType) UnmarshalJSON

func (s *BotServiceChannelType) UnmarshalJSON(bytes []byte) error

type Channel

type Channel interface {
	Channel() BaseChannelImpl
}

func UnmarshalChannelImplementation added in v0.20240920.1135249

func UnmarshalChannelImplementation(input []byte) (Channel, error)

type ChannelClient

type ChannelClient struct {
	Client *resourcemanager.Client
}

func NewChannelClientWithBaseURI

func NewChannelClientWithBaseURI(sdkApi sdkEnv.Api) (*ChannelClient, error)

func (ChannelClient) Create

Create ...

func (ChannelClient) Delete

Delete ...

func (ChannelClient) DirectLineRegenerateKeys

func (c ChannelClient) DirectLineRegenerateKeys(ctx context.Context, id commonids.BotServiceChannelId, input SiteInfo) (result DirectLineRegenerateKeysOperationResponse, err error)

DirectLineRegenerateKeys ...

func (ChannelClient) EmailCreateSignInUrl

func (c ChannelClient) EmailCreateSignInUrl(ctx context.Context, id commonids.BotServiceId) (result EmailCreateSignInUrlOperationResponse, err error)

EmailCreateSignInUrl ...

func (ChannelClient) Get

Get ...

func (ChannelClient) ListByResourceGroup

func (c ChannelClient) ListByResourceGroup(ctx context.Context, id commonids.BotServiceId) (result ListByResourceGroupOperationResponse, err error)

ListByResourceGroup ...

func (ChannelClient) ListByResourceGroupComplete

ListByResourceGroupComplete retrieves all the results into a single object

func (ChannelClient) ListByResourceGroupCompleteMatchingPredicate

func (c ChannelClient) ListByResourceGroupCompleteMatchingPredicate(ctx context.Context, id commonids.BotServiceId, predicate BotChannelOperationPredicate) (result ListByResourceGroupCompleteResult, err error)

ListByResourceGroupCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ChannelClient) ListWithKeys

ListWithKeys ...

func (ChannelClient) Update

Update ...

type ChannelSettings

type ChannelSettings struct {
	BotIconUrl            *string `json:"botIconUrl,omitempty"`
	BotId                 *string `json:"botId,omitempty"`
	ChannelDisplayName    *string `json:"channelDisplayName,omitempty"`
	ChannelId             *string `json:"channelId,omitempty"`
	DisableLocalAuth      *bool   `json:"disableLocalAuth,omitempty"`
	ExtensionKey1         *string `json:"extensionKey1,omitempty"`
	ExtensionKey2         *string `json:"extensionKey2,omitempty"`
	IsEnabled             *bool   `json:"isEnabled,omitempty"`
	RequireTermsAgreement *bool   `json:"requireTermsAgreement,omitempty"`
	Sites                 *[]Site `json:"sites,omitempty"`
}

type CreateEmailSignInUrlResponse

type CreateEmailSignInUrlResponse struct {
	Id         *string                                 `json:"id,omitempty"`
	Location   *string                                 `json:"location,omitempty"`
	Properties *CreateEmailSignInUrlResponseProperties `json:"properties,omitempty"`
}

type CreateEmailSignInUrlResponseProperties

type CreateEmailSignInUrlResponseProperties struct {
	Url *string `json:"url,omitempty"`
}

type CreateOperationResponse

type CreateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *BotChannel
}

type DeleteOperationResponse

type DeleteOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
}

type DirectLineChannel

type DirectLineChannel struct {
	Properties *DirectLineChannelProperties `json:"properties,omitempty"`

	ChannelName       string  `json:"channelName"`
	Etag              *string `json:"etag,omitempty"`
	Location          *string `json:"location,omitempty"`
	ProvisioningState *string `json:"provisioningState,omitempty"`
}

func (DirectLineChannel) Channel added in v0.20240920.1135249

func (s DirectLineChannel) Channel() BaseChannelImpl

func (DirectLineChannel) MarshalJSON

func (s DirectLineChannel) MarshalJSON() ([]byte, error)

type DirectLineChannelProperties

type DirectLineChannelProperties struct {
	DirectLineEmbedCode *string `json:"DirectLineEmbedCode,omitempty"`
	ExtensionKey1       *string `json:"extensionKey1,omitempty"`
	ExtensionKey2       *string `json:"extensionKey2,omitempty"`
	Sites               *[]Site `json:"sites,omitempty"`
}

type DirectLineRegenerateKeysOperationResponse

type DirectLineRegenerateKeysOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *BotChannel
}

type DirectLineSpeechChannel

type DirectLineSpeechChannel struct {
	Properties *DirectLineSpeechChannelProperties `json:"properties,omitempty"`

	ChannelName       string  `json:"channelName"`
	Etag              *string `json:"etag,omitempty"`
	Location          *string `json:"location,omitempty"`
	ProvisioningState *string `json:"provisioningState,omitempty"`
}

func (DirectLineSpeechChannel) Channel added in v0.20240920.1135249

func (DirectLineSpeechChannel) MarshalJSON

func (s DirectLineSpeechChannel) MarshalJSON() ([]byte, error)

type DirectLineSpeechChannelProperties

type DirectLineSpeechChannelProperties struct {
	CognitiveServiceRegion          *string `json:"cognitiveServiceRegion,omitempty"`
	CognitiveServiceResourceId      *string `json:"cognitiveServiceResourceId,omitempty"`
	CognitiveServiceSubscriptionKey *string `json:"cognitiveServiceSubscriptionKey,omitempty"`
	CustomSpeechModelId             *string `json:"customSpeechModelId,omitempty"`
	CustomVoiceDeploymentId         *string `json:"customVoiceDeploymentId,omitempty"`
	IsDefaultBotForCogSvcAccount    *bool   `json:"isDefaultBotForCogSvcAccount,omitempty"`
	IsEnabled                       *bool   `json:"isEnabled,omitempty"`
}

type EmailChannel

type EmailChannel struct {
	Properties *EmailChannelProperties `json:"properties,omitempty"`

	ChannelName       string  `json:"channelName"`
	Etag              *string `json:"etag,omitempty"`
	Location          *string `json:"location,omitempty"`
	ProvisioningState *string `json:"provisioningState,omitempty"`
}

func (EmailChannel) Channel added in v0.20240920.1135249

func (s EmailChannel) Channel() BaseChannelImpl

func (EmailChannel) MarshalJSON

func (s EmailChannel) MarshalJSON() ([]byte, error)

type EmailChannelAuthMethod

type EmailChannelAuthMethod int64
const (
	EmailChannelAuthMethodOne  EmailChannelAuthMethod = 1
	EmailChannelAuthMethodZero EmailChannelAuthMethod = 0
)

type EmailChannelProperties

type EmailChannelProperties struct {
	AuthMethod   *EmailChannelAuthMethod `json:"authMethod,omitempty"`
	EmailAddress string                  `json:"emailAddress"`
	IsEnabled    bool                    `json:"isEnabled"`
	MagicCode    *string                 `json:"magicCode,omitempty"`
	Password     *string                 `json:"password,omitempty"`
}

type EmailCreateSignInUrlOperationResponse

type EmailCreateSignInUrlOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *CreateEmailSignInUrlResponse
}

type FacebookChannel

type FacebookChannel struct {
	Properties *FacebookChannelProperties `json:"properties,omitempty"`

	ChannelName       string  `json:"channelName"`
	Etag              *string `json:"etag,omitempty"`
	Location          *string `json:"location,omitempty"`
	ProvisioningState *string `json:"provisioningState,omitempty"`
}

func (FacebookChannel) Channel added in v0.20240920.1135249

func (s FacebookChannel) Channel() BaseChannelImpl

func (FacebookChannel) MarshalJSON

func (s FacebookChannel) MarshalJSON() ([]byte, error)

type FacebookChannelProperties

type FacebookChannelProperties struct {
	AppId       string          `json:"appId"`
	AppSecret   *string         `json:"appSecret,omitempty"`
	CallbackUrl *string         `json:"callbackUrl,omitempty"`
	IsEnabled   bool            `json:"isEnabled"`
	Pages       *[]FacebookPage `json:"pages,omitempty"`
	VerifyToken *string         `json:"verifyToken,omitempty"`
}

type FacebookPage

type FacebookPage struct {
	AccessToken *string `json:"accessToken,omitempty"`
	Id          string  `json:"id"`
}

type GetOperationResponse

type GetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *BotChannel
}

type Key

type Key string
const (
	KeyKeyOne Key = "key1"
	KeyKeyTwo Key = "key2"
)

func (*Key) UnmarshalJSON

func (s *Key) UnmarshalJSON(bytes []byte) error

type KikChannel

type KikChannel struct {
	Properties *KikChannelProperties `json:"properties,omitempty"`

	ChannelName       string  `json:"channelName"`
	Etag              *string `json:"etag,omitempty"`
	Location          *string `json:"location,omitempty"`
	ProvisioningState *string `json:"provisioningState,omitempty"`
}

func (KikChannel) Channel added in v0.20240920.1135249

func (s KikChannel) Channel() BaseChannelImpl

func (KikChannel) MarshalJSON

func (s KikChannel) MarshalJSON() ([]byte, error)

type KikChannelProperties

type KikChannelProperties struct {
	ApiKey      *string `json:"apiKey,omitempty"`
	IsEnabled   bool    `json:"isEnabled"`
	IsValidated *bool   `json:"isValidated,omitempty"`
	UserName    string  `json:"userName"`
}

type Kind

type Kind string
const (
	KindAzurebot Kind = "azurebot"
	KindBot      Kind = "bot"
	KindDesigner Kind = "designer"
	KindFunction Kind = "function"
	KindSdk      Kind = "sdk"
)

func (*Kind) UnmarshalJSON

func (s *Kind) UnmarshalJSON(bytes []byte) error

type LineChannel

type LineChannel struct {
	Properties *LineChannelProperties `json:"properties,omitempty"`

	ChannelName       string  `json:"channelName"`
	Etag              *string `json:"etag,omitempty"`
	Location          *string `json:"location,omitempty"`
	ProvisioningState *string `json:"provisioningState,omitempty"`
}

func (LineChannel) Channel added in v0.20240920.1135249

func (s LineChannel) Channel() BaseChannelImpl

func (LineChannel) MarshalJSON

func (s LineChannel) MarshalJSON() ([]byte, error)

type LineChannelProperties

type LineChannelProperties struct {
	CallbackUrl       *string            `json:"callbackUrl,omitempty"`
	IsValidated       *bool              `json:"isValidated,omitempty"`
	LineRegistrations []LineRegistration `json:"lineRegistrations"`
}

type LineRegistration

type LineRegistration struct {
	ChannelAccessToken *string `json:"channelAccessToken,omitempty"`
	ChannelSecret      *string `json:"channelSecret,omitempty"`
	GeneratedId        *string `json:"generatedId,omitempty"`
}

type ListByResourceGroupCompleteResult

type ListByResourceGroupCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []BotChannel
}

type ListByResourceGroupCustomPager added in v0.20240628.1153531

type ListByResourceGroupCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *ListByResourceGroupCustomPager) NextPageLink() *odata.Link

type ListByResourceGroupOperationResponse

type ListByResourceGroupOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]BotChannel
}

type ListChannelWithKeysResponse

type ListChannelWithKeysResponse struct {
	ChangedTime       *string            `json:"changedTime,omitempty"`
	EntityTag         *string            `json:"entityTag,omitempty"`
	Etag              *string            `json:"etag,omitempty"`
	Id                *string            `json:"id,omitempty"`
	Kind              *Kind              `json:"kind,omitempty"`
	Location          *string            `json:"location,omitempty"`
	Name              *string            `json:"name,omitempty"`
	Properties        Channel            `json:"properties"`
	ProvisioningState *string            `json:"provisioningState,omitempty"`
	Resource          Channel            `json:"resource"`
	Setting           *ChannelSettings   `json:"setting,omitempty"`
	Sku               *Sku               `json:"sku,omitempty"`
	Tags              *map[string]string `json:"tags,omitempty"`
	Type              *string            `json:"type,omitempty"`
	Zones             *zones.Schema      `json:"zones,omitempty"`
}

func (*ListChannelWithKeysResponse) UnmarshalJSON

func (s *ListChannelWithKeysResponse) UnmarshalJSON(bytes []byte) error

type ListWithKeysOperationResponse

type ListWithKeysOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ListChannelWithKeysResponse
}

type M365Extensions

type M365Extensions struct {
	ChannelName       string  `json:"channelName"`
	Etag              *string `json:"etag,omitempty"`
	Location          *string `json:"location,omitempty"`
	ProvisioningState *string `json:"provisioningState,omitempty"`
}

func (M365Extensions) Channel added in v0.20240920.1135249

func (s M365Extensions) Channel() BaseChannelImpl

func (M365Extensions) MarshalJSON

func (s M365Extensions) MarshalJSON() ([]byte, error)

type MsTeamsChannel

type MsTeamsChannel struct {
	Properties *MsTeamsChannelProperties `json:"properties,omitempty"`

	ChannelName       string  `json:"channelName"`
	Etag              *string `json:"etag,omitempty"`
	Location          *string `json:"location,omitempty"`
	ProvisioningState *string `json:"provisioningState,omitempty"`
}

func (MsTeamsChannel) Channel added in v0.20240920.1135249

func (s MsTeamsChannel) Channel() BaseChannelImpl

func (MsTeamsChannel) MarshalJSON

func (s MsTeamsChannel) MarshalJSON() ([]byte, error)

type MsTeamsChannelProperties

type MsTeamsChannelProperties struct {
	AcceptedTerms         *bool   `json:"acceptedTerms,omitempty"`
	CallingWebhook        *string `json:"callingWebhook,omitempty"`
	DeploymentEnvironment *string `json:"deploymentEnvironment,omitempty"`
	EnableCalling         *bool   `json:"enableCalling,omitempty"`
	IncomingCallRoute     *string `json:"incomingCallRoute,omitempty"`
	IsEnabled             bool    `json:"isEnabled"`
}

type Omnichannel

type Omnichannel struct {
	ChannelName       string  `json:"channelName"`
	Etag              *string `json:"etag,omitempty"`
	Location          *string `json:"location,omitempty"`
	ProvisioningState *string `json:"provisioningState,omitempty"`
}

func (Omnichannel) Channel added in v0.20240920.1135249

func (s Omnichannel) Channel() BaseChannelImpl

func (Omnichannel) MarshalJSON

func (s Omnichannel) MarshalJSON() ([]byte, error)

type OutlookChannel

type OutlookChannel struct {
	ChannelName       string  `json:"channelName"`
	Etag              *string `json:"etag,omitempty"`
	Location          *string `json:"location,omitempty"`
	ProvisioningState *string `json:"provisioningState,omitempty"`
}

func (OutlookChannel) Channel added in v0.20240920.1135249

func (s OutlookChannel) Channel() BaseChannelImpl

func (OutlookChannel) MarshalJSON

func (s OutlookChannel) MarshalJSON() ([]byte, error)

type RawChannelImpl

type RawChannelImpl struct {
	Type   string
	Values map[string]interface{}
	// contains filtered or unexported fields
}

RawChannelImpl is returned when the Discriminated Value doesn't match any of the defined types NOTE: this should only be used when a type isn't defined for this type of Object (as a workaround) and is used only for Deserialization (e.g. this cannot be used as a Request Payload).

func (RawChannelImpl) Channel added in v0.20240920.1135249

func (s RawChannelImpl) Channel() BaseChannelImpl

type SearchAssistant

type SearchAssistant struct {
	ChannelName       string  `json:"channelName"`
	Etag              *string `json:"etag,omitempty"`
	Location          *string `json:"location,omitempty"`
	ProvisioningState *string `json:"provisioningState,omitempty"`
}

func (SearchAssistant) Channel added in v0.20240920.1135249

func (s SearchAssistant) Channel() BaseChannelImpl

func (SearchAssistant) MarshalJSON

func (s SearchAssistant) MarshalJSON() ([]byte, error)

type Site

type Site struct {
	AppId                       *string   `json:"appId,omitempty"`
	ETag                        *string   `json:"eTag,omitempty"`
	IsBlockUserUploadEnabled    *bool     `json:"isBlockUserUploadEnabled,omitempty"`
	IsDetailedLoggingEnabled    *bool     `json:"isDetailedLoggingEnabled,omitempty"`
	IsEnabled                   bool      `json:"isEnabled"`
	IsEndpointParametersEnabled *bool     `json:"isEndpointParametersEnabled,omitempty"`
	IsNoStorageEnabled          *bool     `json:"isNoStorageEnabled,omitempty"`
	IsSecureSiteEnabled         *bool     `json:"isSecureSiteEnabled,omitempty"`
	IsTokenEnabled              *bool     `json:"isTokenEnabled,omitempty"`
	IsV1Enabled                 *bool     `json:"isV1Enabled,omitempty"`
	IsV3Enabled                 *bool     `json:"isV3Enabled,omitempty"`
	IsWebChatSpeechEnabled      *bool     `json:"isWebChatSpeechEnabled,omitempty"`
	IsWebchatPreviewEnabled     *bool     `json:"isWebchatPreviewEnabled,omitempty"`
	Key                         *string   `json:"key,omitempty"`
	Key2                        *string   `json:"key2,omitempty"`
	SiteId                      *string   `json:"siteId,omitempty"`
	SiteName                    string    `json:"siteName"`
	TenantId                    *string   `json:"tenantId,omitempty"`
	TrustedOrigins              *[]string `json:"trustedOrigins,omitempty"`
}

type SiteInfo

type SiteInfo struct {
	Key      Key    `json:"key"`
	SiteName string `json:"siteName"`
}

type Sku

type Sku struct {
	Name SkuName  `json:"name"`
	Tier *SkuTier `json:"tier,omitempty"`
}

type SkuName

type SkuName string
const (
	SkuNameFZero SkuName = "F0"
	SkuNameSOne  SkuName = "S1"
)

func (*SkuName) UnmarshalJSON

func (s *SkuName) UnmarshalJSON(bytes []byte) error

type SkuTier

type SkuTier string
const (
	SkuTierFree     SkuTier = "Free"
	SkuTierStandard SkuTier = "Standard"
)

func (*SkuTier) UnmarshalJSON

func (s *SkuTier) UnmarshalJSON(bytes []byte) error

type SkypeChannel

type SkypeChannel struct {
	Properties *SkypeChannelProperties `json:"properties,omitempty"`

	ChannelName       string  `json:"channelName"`
	Etag              *string `json:"etag,omitempty"`
	Location          *string `json:"location,omitempty"`
	ProvisioningState *string `json:"provisioningState,omitempty"`
}

func (SkypeChannel) Channel added in v0.20240920.1135249

func (s SkypeChannel) Channel() BaseChannelImpl

func (SkypeChannel) MarshalJSON

func (s SkypeChannel) MarshalJSON() ([]byte, error)

type SkypeChannelProperties

type SkypeChannelProperties struct {
	CallingWebHook      *string `json:"callingWebHook,omitempty"`
	EnableCalling       *bool   `json:"enableCalling,omitempty"`
	EnableGroups        *bool   `json:"enableGroups,omitempty"`
	EnableMediaCards    *bool   `json:"enableMediaCards,omitempty"`
	EnableMessaging     *bool   `json:"enableMessaging,omitempty"`
	EnableScreenSharing *bool   `json:"enableScreenSharing,omitempty"`
	EnableVideo         *bool   `json:"enableVideo,omitempty"`
	GroupsMode          *string `json:"groupsMode,omitempty"`
	IncomingCallRoute   *string `json:"incomingCallRoute,omitempty"`
	IsEnabled           bool    `json:"isEnabled"`
}

type SlackChannel

type SlackChannel struct {
	Properties *SlackChannelProperties `json:"properties,omitempty"`

	ChannelName       string  `json:"channelName"`
	Etag              *string `json:"etag,omitempty"`
	Location          *string `json:"location,omitempty"`
	ProvisioningState *string `json:"provisioningState,omitempty"`
}

func (SlackChannel) Channel added in v0.20240920.1135249

func (s SlackChannel) Channel() BaseChannelImpl

func (SlackChannel) MarshalJSON

func (s SlackChannel) MarshalJSON() ([]byte, error)

type SlackChannelProperties

type SlackChannelProperties struct {
	ClientId                *string `json:"clientId,omitempty"`
	ClientSecret            *string `json:"clientSecret,omitempty"`
	IsEnabled               bool    `json:"isEnabled"`
	IsValidated             *bool   `json:"IsValidated,omitempty"`
	LandingPageUrl          *string `json:"landingPageUrl,omitempty"`
	LastSubmissionId        *string `json:"lastSubmissionId,omitempty"`
	RedirectAction          *string `json:"redirectAction,omitempty"`
	RegisterBeforeOAuthFlow *bool   `json:"registerBeforeOAuthFlow,omitempty"`
	Scopes                  *string `json:"scopes,omitempty"`
	SigningSecret           *string `json:"signingSecret,omitempty"`
	VerificationToken       *string `json:"verificationToken,omitempty"`
}

type SmsChannel

type SmsChannel struct {
	Properties *SmsChannelProperties `json:"properties,omitempty"`

	ChannelName       string  `json:"channelName"`
	Etag              *string `json:"etag,omitempty"`
	Location          *string `json:"location,omitempty"`
	ProvisioningState *string `json:"provisioningState,omitempty"`
}

func (SmsChannel) Channel added in v0.20240920.1135249

func (s SmsChannel) Channel() BaseChannelImpl

func (SmsChannel) MarshalJSON

func (s SmsChannel) MarshalJSON() ([]byte, error)

type SmsChannelProperties

type SmsChannelProperties struct {
	AccountSID  string  `json:"accountSID"`
	AuthToken   *string `json:"authToken,omitempty"`
	IsEnabled   bool    `json:"isEnabled"`
	IsValidated *bool   `json:"isValidated,omitempty"`
	Phone       string  `json:"phone"`
}

type TelegramChannel

type TelegramChannel struct {
	Properties *TelegramChannelProperties `json:"properties,omitempty"`

	ChannelName       string  `json:"channelName"`
	Etag              *string `json:"etag,omitempty"`
	Location          *string `json:"location,omitempty"`
	ProvisioningState *string `json:"provisioningState,omitempty"`
}

func (TelegramChannel) Channel added in v0.20240920.1135249

func (s TelegramChannel) Channel() BaseChannelImpl

func (TelegramChannel) MarshalJSON

func (s TelegramChannel) MarshalJSON() ([]byte, error)

type TelegramChannelProperties

type TelegramChannelProperties struct {
	AccessToken *string `json:"accessToken,omitempty"`
	IsEnabled   bool    `json:"isEnabled"`
	IsValidated *bool   `json:"isValidated,omitempty"`
}

type TelephonyChannel

type TelephonyChannel struct {
	Properties *TelephonyChannelProperties `json:"properties,omitempty"`

	ChannelName       string  `json:"channelName"`
	Etag              *string `json:"etag,omitempty"`
	Location          *string `json:"location,omitempty"`
	ProvisioningState *string `json:"provisioningState,omitempty"`
}

func (TelephonyChannel) Channel added in v0.20240920.1135249

func (s TelephonyChannel) Channel() BaseChannelImpl

func (TelephonyChannel) MarshalJSON

func (s TelephonyChannel) MarshalJSON() ([]byte, error)

type TelephonyChannelProperties

type TelephonyChannelProperties struct {
	ApiConfigurations               *[]TelephonyChannelResourceApiConfiguration `json:"apiConfigurations,omitempty"`
	CognitiveServiceRegion          *string                                     `json:"cognitiveServiceRegion,omitempty"`
	CognitiveServiceSubscriptionKey *string                                     `json:"cognitiveServiceSubscriptionKey,omitempty"`
	DefaultLocale                   *string                                     `json:"defaultLocale,omitempty"`
	IsEnabled                       *bool                                       `json:"isEnabled,omitempty"`
	PhoneNumbers                    *[]TelephonyPhoneNumbers                    `json:"phoneNumbers,omitempty"`
	PremiumSKU                      *string                                     `json:"premiumSKU,omitempty"`
}

type TelephonyChannelResourceApiConfiguration

type TelephonyChannelResourceApiConfiguration struct {
	CognitiveServiceRegion          *string `json:"cognitiveServiceRegion,omitempty"`
	CognitiveServiceResourceId      *string `json:"cognitiveServiceResourceId,omitempty"`
	CognitiveServiceSubscriptionKey *string `json:"cognitiveServiceSubscriptionKey,omitempty"`
	DefaultLocale                   *string `json:"defaultLocale,omitempty"`
	Id                              *string `json:"id,omitempty"`
	ProviderName                    *string `json:"providerName,omitempty"`
}

type TelephonyPhoneNumbers

type TelephonyPhoneNumbers struct {
	AcsEndpoint                     *string `json:"acsEndpoint,omitempty"`
	AcsResourceId                   *string `json:"acsResourceId,omitempty"`
	AcsSecret                       *string `json:"acsSecret,omitempty"`
	CognitiveServiceRegion          *string `json:"cognitiveServiceRegion,omitempty"`
	CognitiveServiceResourceId      *string `json:"cognitiveServiceResourceId,omitempty"`
	CognitiveServiceSubscriptionKey *string `json:"cognitiveServiceSubscriptionKey,omitempty"`
	DefaultLocale                   *string `json:"defaultLocale,omitempty"`
	Id                              *string `json:"id,omitempty"`
	OfferType                       *string `json:"offerType,omitempty"`
	PhoneNumber                     *string `json:"phoneNumber,omitempty"`
}

type UpdateOperationResponse

type UpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *BotChannel
}

type WebChatChannel

type WebChatChannel struct {
	Properties *WebChatChannelProperties `json:"properties,omitempty"`

	ChannelName       string  `json:"channelName"`
	Etag              *string `json:"etag,omitempty"`
	Location          *string `json:"location,omitempty"`
	ProvisioningState *string `json:"provisioningState,omitempty"`
}

func (WebChatChannel) Channel added in v0.20240920.1135249

func (s WebChatChannel) Channel() BaseChannelImpl

func (WebChatChannel) MarshalJSON

func (s WebChatChannel) MarshalJSON() ([]byte, error)

type WebChatChannelProperties

type WebChatChannelProperties struct {
	Sites            *[]Site `json:"sites,omitempty"`
	WebChatEmbedCode *string `json:"webChatEmbedCode,omitempty"`
}

Source Files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL