WidgetServiceClient class
생성자
| Widget |
|
| Widget |
메서드
| analyze |
위젯을 분석합니다. 유일한 보장은 이 메서드가 분석 결과를 포함하는 문자열을 반환한다는 것입니다. |
| create |
새 위젯을 만듭니다. 위젯 ID는 서버에서 자동으로 설정되므로 만드는 동안 필요하지 않습니다. ID를 제공하면 오류가 발생합니다. |
| delete |
ID별 위젯을 삭제합니다. |
| get |
ID별 위젯을 가져옵니다. |
| list |
시스템의 모든 위젯을 나열합니다. 이 작업은 페이지를 매기지 않고 간단한 위젯 배열을 반환합니다. 옵션이나 매개 변수는 허용하지 않습니다. |
| update |
위젯의 내용을 업데이트합니다. 위젯 ID는 입력에 필요하지만 변경할 수 없습니다. 다른 모든 필드는 선택 사항이며 제공된 경우 위젯 내에서 업데이트됩니다. |
생성자 세부 정보
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)
새 위젯을 만듭니다.
위젯 ID는 서버에서 자동으로 설정되므로 만드는 동안 필요하지 않습니다. ID를 제공하면 오류가 발생합니다.
function createWidget(weight: number, color: ColorType, options?: CreateWidgetOptions): Promise<Widget>
매개 변수
- weight
-
number
- color
- ColorType
- options
- CreateWidgetOptions
반환
Promise<Widget>
deleteWidget(string, DeleteWidgetOptions)
ID별 위젯을 삭제합니다.
function deleteWidget(id: string, options?: DeleteWidgetOptions): Promise<void>
매개 변수
- id
-
string
- options
- DeleteWidgetOptions
반환
Promise<void>
getWidget(string, GetWidgetOptions)
ID별 위젯을 가져옵니다.
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)
위젯의 내용을 업데이트합니다. 위젯 ID는 입력에 필요하지만 변경할 수 없습니다. 다른 모든 필드는 선택 사항이며 제공된 경우 위젯 내에서 업데이트됩니다.
function updateWidget(id: string, options?: UpdateWidgetOptions): Promise<Widget>
매개 변수
- id
-
string
- options
- UpdateWidgetOptions
반환
Promise<Widget>