WidgetServiceClient class

Konstruktor

WidgetServiceClient(string, TokenCredential, WidgetServiceClientOptions)
WidgetServiceClient(string, WidgetServiceClientOptions)

Metode

analyzeWidget(string, AnalyzeWidgetOptions)

Menganalisis widget. Satu-satunya jaminan adalah bahwa metode ini akan mengembalikan string yang berisi hasil analisis.

createWidget(number, ColorType, CreateWidgetOptions)

Buat widget baru.

ID widget tidak diperlukan selama pembuatan, karena secara otomatis diatur oleh server. Memberikan ID akan mengakibatkan kesalahan.

deleteWidget(string, DeleteWidgetOptions)

Hapus widget menurut ID.

getWidget(string, GetWidgetOptions)

Dapatkan widget berdasarkan ID.

listWidgets(ListWidgetsOptions)

Cantumkan semua widget dalam sistem. Operasi ini tidak dipaginasi, dan mengembalikan array widget sederhana.

Ini tidak menerima opsi atau parameter apa pun.

updateWidget(string, UpdateWidgetOptions)

Perbarui konten widget. ID widget diperlukan dalam input, tetapi tidak dapat diubah. Semua bidang lain bersifat opsional dan akan diperbarui dalam widget jika disediakan.

Detail Konstruktor

WidgetServiceClient(string, TokenCredential, WidgetServiceClientOptions)

new WidgetServiceClient(endpoint: string, credential: TokenCredential, options?: WidgetServiceClientOptions)

Parameter

endpoint

string

credential
TokenCredential

WidgetServiceClient(string, WidgetServiceClientOptions)

new WidgetServiceClient(endpoint: string, options?: WidgetServiceClientOptions)

Parameter

endpoint

string

Detail Metode

analyzeWidget(string, AnalyzeWidgetOptions)

Menganalisis widget. Satu-satunya jaminan adalah bahwa metode ini akan mengembalikan string yang berisi hasil analisis.

function analyzeWidget(id: string, options?: AnalyzeWidgetOptions): Promise<AnalyzeResult>

Parameter

id

string

Mengembalikan

Promise<AnalyzeResult>

createWidget(number, ColorType, CreateWidgetOptions)

Buat widget baru.

ID widget tidak diperlukan selama pembuatan, karena secara otomatis diatur oleh server. Memberikan ID akan mengakibatkan kesalahan.

function createWidget(weight: number, color: ColorType, options?: CreateWidgetOptions): Promise<Widget>

Parameter

weight

number

color
ColorType

Mengembalikan

Promise<Widget>

deleteWidget(string, DeleteWidgetOptions)

Hapus widget menurut ID.

function deleteWidget(id: string, options?: DeleteWidgetOptions): Promise<void>

Parameter

id

string

Mengembalikan

Promise<void>

getWidget(string, GetWidgetOptions)

Dapatkan widget berdasarkan ID.

function getWidget(id: string, options?: GetWidgetOptions): Promise<Widget>

Parameter

id

string

Mengembalikan

Promise<Widget>

listWidgets(ListWidgetsOptions)

Cantumkan semua widget dalam sistem. Operasi ini tidak dipaginasi, dan mengembalikan array widget sederhana.

Ini tidak menerima opsi atau parameter apa pun.

function listWidgets(options?: ListWidgetsOptions): Promise<Widget[]>

Parameter

Mengembalikan

Promise<Widget[]>

updateWidget(string, UpdateWidgetOptions)

Perbarui konten widget. ID widget diperlukan dalam input, tetapi tidak dapat diubah. Semua bidang lain bersifat opsional dan akan diperbarui dalam widget jika disediakan.

function updateWidget(id: string, options?: UpdateWidgetOptions): Promise<Widget>

Parameter

id

string

Mengembalikan

Promise<Widget>