Dela via

ShortCodesClient class

Paket:
@azure-tools/communication-short-codes

Konstruktorer

ShortCodesClient(string, KeyCredential, ShortCodesClientOptions)
ShortCodesClient(string, ShortCodesClientOptions)
ShortCodesClient(string, TokenCredential, ShortCodesClientOptions)

Metoder

createOrReplaceUSProgramBriefAttachment(string, string, string, FileType, string, AttachmentType, ShortCodesCreateOrReplaceUSProgramBriefAttachmentOptionalParams)
deleteUSProgramBrief(string, DeleteUSProgramBriefOptions)
deleteUSProgramBriefAttachment(string, string, ShortCodesDeleteUSProgramBriefAttachmentOptionalParams)
getUSProgramBrief(string, GetUSProgramBriefOptions)
getUSProgramBriefAttachment(string, string, ShortCodesGetUSProgramBriefAttachmentOptionalParams)
listShortCodes(ListShortCodesOptions)
listUSProgramBriefAttachments(string, ShortCodesGetUSProgramBriefAttachmentsOptionalParams)
listUSProgramBriefs(ListUSProgramBriefsOptions)
submitUSProgramBrief(string, SubmitUSProgramBriefOptions)
upsertUSProgramBrief(string, ShortCodesUpsertUSProgramBriefOptionalParams)

Konstruktorinformation

ShortCodesClient(string, KeyCredential, ShortCodesClientOptions) 

new ShortCodesClient(endpoint: string, credential: KeyCredential, options?: ShortCodesClientOptions)

Parametrar

endpoint

string

credential
KeyCredential
options
ShortCodesClientOptions

ShortCodesClient(string, ShortCodesClientOptions) 

new ShortCodesClient(connectionString: string, options?: ShortCodesClientOptions)

Parametrar

connectionString

string

options
ShortCodesClientOptions

ShortCodesClient(string, TokenCredential, ShortCodesClientOptions) 

new ShortCodesClient(endpoint: string, credential: TokenCredential, options?: ShortCodesClientOptions)

Parametrar

endpoint

string

credential
TokenCredential
options
ShortCodesClientOptions

Metodinformation

createOrReplaceUSProgramBriefAttachment(string, string, string, FileType, string, AttachmentType, ShortCodesCreateOrReplaceUSProgramBriefAttachmentOptionalParams) 

function createOrReplaceUSProgramBriefAttachment(programBriefId: string, attachmentId: string, fileName: string, fileType: FileType, fileContent: string, attachmentType: AttachmentType, options?: ShortCodesCreateOrReplaceUSProgramBriefAttachmentOptionalParams): Promise<ProgramBriefAttachment>

Parametrar

programBriefId

string

attachmentId

string

fileName

string

fileType
FileType
fileContent

string

attachmentType
AttachmentType
options
ShortCodesCreateOrReplaceUSProgramBriefAttachmentOptionalParams

Returer

Promise<ProgramBriefAttachment>

deleteUSProgramBrief(string, DeleteUSProgramBriefOptions) 

function deleteUSProgramBrief(programBriefId: string, options?: DeleteUSProgramBriefOptions): Promise<void>

Parametrar

programBriefId

string

options
DeleteUSProgramBriefOptions

Returer

Promise<void>

deleteUSProgramBriefAttachment(string, string, ShortCodesDeleteUSProgramBriefAttachmentOptionalParams) 

function deleteUSProgramBriefAttachment(programBriefId: string, attachmentId: string, options?: ShortCodesDeleteUSProgramBriefAttachmentOptionalParams): Promise<void>

Parametrar

programBriefId

string

attachmentId

string

options
ShortCodesDeleteUSProgramBriefAttachmentOptionalParams

Returer

Promise<void>

getUSProgramBrief(string, GetUSProgramBriefOptions) 

function getUSProgramBrief(programBriefId: string, options?: GetUSProgramBriefOptions): Promise<USProgramBrief>

Parametrar

programBriefId

string

options
GetUSProgramBriefOptions

Returer

Promise<USProgramBrief>

getUSProgramBriefAttachment(string, string, ShortCodesGetUSProgramBriefAttachmentOptionalParams) 

function getUSProgramBriefAttachment(programBriefId: string, attachmentId: string, options?: ShortCodesGetUSProgramBriefAttachmentOptionalParams): Promise<ProgramBriefAttachment>

Parametrar

programBriefId

string

attachmentId

string

options
ShortCodesGetUSProgramBriefAttachmentOptionalParams

Returer

Promise<ProgramBriefAttachment>

listShortCodes(ListShortCodesOptions) 

function listShortCodes(options?: ListShortCodesOptions): PagedAsyncIterableIterator<ShortCode, ShortCode[], PageSettings>

Parametrar

options
ListShortCodesOptions

Returer

PagedAsyncIterableIterator<ShortCode, ShortCode[], PageSettings>

listUSProgramBriefAttachments(string, ShortCodesGetUSProgramBriefAttachmentsOptionalParams) 

function listUSProgramBriefAttachments(programBriefId: string, options?: ShortCodesGetUSProgramBriefAttachmentsOptionalParams): PagedAsyncIterableIterator<ProgramBriefAttachment, ProgramBriefAttachment[], PageSettings>

Parametrar

programBriefId

string

options
ShortCodesGetUSProgramBriefAttachmentsOptionalParams

Returer

PagedAsyncIterableIterator<ProgramBriefAttachment, ProgramBriefAttachment[], PageSettings>

listUSProgramBriefs(ListUSProgramBriefsOptions) 

function listUSProgramBriefs(options?: ListUSProgramBriefsOptions): PagedAsyncIterableIterator<USProgramBrief, USProgramBrief[], PageSettings>

Parametrar

options
ListUSProgramBriefsOptions

Returer

PagedAsyncIterableIterator<USProgramBrief, USProgramBrief[], PageSettings>

submitUSProgramBrief(string, SubmitUSProgramBriefOptions) 

function submitUSProgramBrief(programBriefId: string, options?: SubmitUSProgramBriefOptions): Promise<USProgramBrief>

Parametrar

programBriefId

string

options
SubmitUSProgramBriefOptions

Returer

Promise<USProgramBrief>

upsertUSProgramBrief(string, ShortCodesUpsertUSProgramBriefOptionalParams) 

function upsertUSProgramBrief(programBriefId: string, options?: ShortCodesUpsertUSProgramBriefOptionalParams): Promise<USProgramBrief>

Parametrar

programBriefId

string

options
ShortCodesUpsertUSProgramBriefOptionalParams

Returer

Promise<USProgramBrief>