WidgetServiceClient class
建構函式
| Widget |
|
| Widget |
方法
| analyze |
分析小工具。 唯一的保證是此方法會傳回包含分析結果的字串。 |
| create |
建立新的小工具。 建立期間不需要小工具標識碼,因為伺服器會自動設定。 提供標識碼會導致錯誤。 |
| delete |
依標識碼刪除小工具。 |
| get |
依標識碼取得小工具。 |
| list |
列出系統中的所有小工具。 此作業不會分頁,並傳回簡單的小工具陣列。 它不接受任何選項或參數。 |
| update |
更新小工具的內容。 輸入中需要小工具標識碼,但無法變更。 所有其他欄位都是選擇性的,如果提供,則會在小工具內更新。 |
建構函式詳細資料
WidgetServiceClient(string, TokenCredential, WidgetServiceClientOptions)
new WidgetServiceClient(endpoint: string, credential: TokenCredential, options?: WidgetServiceClientOptions)
參數
- endpoint
-
string
- credential
- TokenCredential
- options
- WidgetServiceClientOptions
WidgetServiceClient(string, WidgetServiceClientOptions)
new WidgetServiceClient(endpoint: string, options?: WidgetServiceClientOptions)
參數
- endpoint
-
string
- options
- WidgetServiceClientOptions
方法詳細資料
analyzeWidget(string, AnalyzeWidgetOptions)
分析小工具。 唯一的保證是此方法會傳回包含分析結果的字串。
function analyzeWidget(id: string, options?: AnalyzeWidgetOptions): Promise<AnalyzeResult>
參數
- id
-
string
- options
- AnalyzeWidgetOptions
傳回
Promise<AnalyzeResult>
createWidget(number, ColorType, CreateWidgetOptions)
建立新的小工具。
建立期間不需要小工具標識碼,因為伺服器會自動設定。 提供標識碼會導致錯誤。
function createWidget(weight: number, color: ColorType, options?: CreateWidgetOptions): Promise<Widget>
參數
- weight
-
number
- color
- ColorType
- options
- CreateWidgetOptions
傳回
Promise<Widget>
deleteWidget(string, DeleteWidgetOptions)
依標識碼刪除小工具。
function deleteWidget(id: string, options?: DeleteWidgetOptions): Promise<void>
參數
- id
-
string
- options
- DeleteWidgetOptions
傳回
Promise<void>
getWidget(string, GetWidgetOptions)
依標識碼取得小工具。
function getWidget(id: string, options?: GetWidgetOptions): Promise<Widget>
參數
- id
-
string
- options
- GetWidgetOptions
傳回
Promise<Widget>
listWidgets(ListWidgetsOptions)
列出系統中的所有小工具。 此作業不會分頁,並傳回簡單的小工具陣列。
它不接受任何選項或參數。
function listWidgets(options?: ListWidgetsOptions): Promise<Widget[]>
參數
- options
- ListWidgetsOptions
傳回
Promise<Widget[]>
updateWidget(string, UpdateWidgetOptions)
更新小工具的內容。 輸入中需要小工具標識碼,但無法變更。 所有其他欄位都是選擇性的,如果提供,則會在小工具內更新。
function updateWidget(id: string, options?: UpdateWidgetOptions): Promise<Widget>
參數
- id
-
string
- options
- UpdateWidgetOptions
傳回
Promise<Widget>