ListManagementTermLists class

  • Reference
Package:
@azure/cognitiveservices-contentmoderator

Class representing a ListManagementTermLists.

Constructors

ListManagementTermLists(ContentModeratorClientContext)

Create a ListManagementTermLists.

Methods

create(string, Body, RequestOptionsBase)

Creates a Term List
create(string, Body, RequestOptionsBase, ServiceCallback<TermList>)
create(string, Body, ServiceCallback<TermList>)
deleteMethod(string, RequestOptionsBase)

Deletes term list with the list Id equal to list Id passed.
deleteMethod(string, RequestOptionsBase, ServiceCallback<string>)
deleteMethod(string, ServiceCallback<string>)
getAllTermLists(RequestOptionsBase)

gets all the Term Lists
getAllTermLists(RequestOptionsBase, ServiceCallback<TermList[]>)
getAllTermLists(ServiceCallback<TermList[]>)
getDetails(string, RequestOptionsBase)

Returns list Id details of the term list with list Id equal to list Id passed.
getDetails(string, RequestOptionsBase, ServiceCallback<TermList>)
getDetails(string, ServiceCallback<TermList>)
refreshIndexMethod(string, string, RequestOptionsBase)

Refreshes the index of the list with list Id equal to list ID passed.
refreshIndexMethod(string, string, RequestOptionsBase, ServiceCallback<RefreshIndex>)
refreshIndexMethod(string, string, ServiceCallback<RefreshIndex>)
update(string, string, Body, RequestOptionsBase)

Updates an Term List.
update(string, string, Body, RequestOptionsBase, ServiceCallback<TermList>)
update(string, string, Body, ServiceCallback<TermList>)

Constructor Details

ListManagementTermLists(ContentModeratorClientContext)

Create a ListManagementTermLists.

new ListManagementTermLists(client: ContentModeratorClientContext)

Parameters

client
ContentModeratorClientContext

Reference to the service client.

Method Details

create(string, Body, RequestOptionsBase)

Creates a Term List

function create(contentType: string, body: Body, options?: RequestOptionsBase): Promise<ListManagementTermListsCreateResponse>

Parameters

contentType

string

The content type.

body
Body

Schema of the body.

options
RequestOptionsBase

The optional parameters

Returns

Promise<ListManagementTermListsCreateResponse>

Promise<Models.ListManagementTermListsCreateResponse>

create(string, Body, RequestOptionsBase, ServiceCallback<TermList>) 

function create(contentType: string, body: Body, options: RequestOptionsBase, callback: ServiceCallback<TermList>)

Parameters

contentType

string

The content type.

body
Body

Schema of the body.

options
RequestOptionsBase

The optional parameters

callback

ServiceCallback<TermList>

The callback

create(string, Body, ServiceCallback<TermList>) 

function create(contentType: string, body: Body, callback: ServiceCallback<TermList>)

Parameters

contentType

string

The content type.

body
Body

Schema of the body.

callback

ServiceCallback<TermList>

The callback

deleteMethod(string, RequestOptionsBase)

Deletes term list with the list Id equal to list Id passed.

function deleteMethod(listId: string, options?: RequestOptionsBase): Promise<ListManagementTermListsDeleteMethodResponse>

Parameters

listId

string

List Id of the image list.

options
RequestOptionsBase

The optional parameters

Returns

Promise<ListManagementTermListsDeleteMethodResponse>

Promise<Models.ListManagementTermListsDeleteMethodResponse>

deleteMethod(string, RequestOptionsBase, ServiceCallback<string>) 

function deleteMethod(listId: string, options: RequestOptionsBase, callback: ServiceCallback<string>)

Parameters

listId

string

List Id of the image list.

options
RequestOptionsBase

The optional parameters

callback

ServiceCallback<string>

The callback

deleteMethod(string, ServiceCallback<string>) 

function deleteMethod(listId: string, callback: ServiceCallback<string>)

Parameters

listId

string

List Id of the image list.

callback

ServiceCallback<string>

The callback

getAllTermLists(RequestOptionsBase)

gets all the Term Lists

function getAllTermLists(options?: RequestOptionsBase): Promise<ListManagementTermListsGetAllTermListsResponse>

Parameters

options
RequestOptionsBase

The optional parameters

Returns

Promise<ListManagementTermListsGetAllTermListsResponse>

Promise<Models.ListManagementTermListsGetAllTermListsResponse>

getAllTermLists(RequestOptionsBase, ServiceCallback<TermList[]>) 

function getAllTermLists(options: RequestOptionsBase, callback: ServiceCallback<TermList[]>)

Parameters

options
RequestOptionsBase

The optional parameters

callback

ServiceCallback<TermList[]>

The callback

getAllTermLists(ServiceCallback<TermList[]>) 

function getAllTermLists(callback: ServiceCallback<TermList[]>)

Parameters

callback

ServiceCallback<TermList[]>

The callback

getDetails(string, RequestOptionsBase)

Returns list Id details of the term list with list Id equal to list Id passed.

function getDetails(listId: string, options?: RequestOptionsBase): Promise<ListManagementTermListsGetDetailsResponse>

Parameters

listId

string

List Id of the image list.

options
RequestOptionsBase

The optional parameters

Returns

Promise<ListManagementTermListsGetDetailsResponse>

Promise<Models.ListManagementTermListsGetDetailsResponse>

getDetails(string, RequestOptionsBase, ServiceCallback<TermList>) 

function getDetails(listId: string, options: RequestOptionsBase, callback: ServiceCallback<TermList>)

Parameters

listId

string

List Id of the image list.

options
RequestOptionsBase

The optional parameters

callback

ServiceCallback<TermList>

The callback

getDetails(string, ServiceCallback<TermList>) 

function getDetails(listId: string, callback: ServiceCallback<TermList>)

Parameters

listId

string

List Id of the image list.

callback

ServiceCallback<TermList>

The callback

refreshIndexMethod(string, string, RequestOptionsBase)

Refreshes the index of the list with list Id equal to list ID passed.

function refreshIndexMethod(listId: string, language: string, options?: RequestOptionsBase): Promise<ListManagementTermListsRefreshIndexMethodResponse>

Parameters

listId

string

List Id of the image list.

language

string

Language of the terms.

options
RequestOptionsBase

The optional parameters

Returns

Promise<ListManagementTermListsRefreshIndexMethodResponse>

Promise<Models.ListManagementTermListsRefreshIndexMethodResponse>

refreshIndexMethod(string, string, RequestOptionsBase, ServiceCallback<RefreshIndex>) 

function refreshIndexMethod(listId: string, language: string, options: RequestOptionsBase, callback: ServiceCallback<RefreshIndex>)

Parameters

listId

string

List Id of the image list.

language

string

Language of the terms.

options
RequestOptionsBase

The optional parameters

callback

ServiceCallback<RefreshIndex>

The callback

refreshIndexMethod(string, string, ServiceCallback<RefreshIndex>) 

function refreshIndexMethod(listId: string, language: string, callback: ServiceCallback<RefreshIndex>)

Parameters

listId

string

List Id of the image list.

language

string

Language of the terms.

callback

ServiceCallback<RefreshIndex>

The callback

update(string, string, Body, RequestOptionsBase)

Updates an Term List.

function update(listId: string, contentType: string, body: Body, options?: RequestOptionsBase): Promise<ListManagementTermListsUpdateResponse>

Parameters

listId

string

List Id of the image list.

contentType

string

The content type.

body
Body

Schema of the body.

options
RequestOptionsBase

The optional parameters

Returns

Promise<ListManagementTermListsUpdateResponse>

Promise<Models.ListManagementTermListsUpdateResponse>

update(string, string, Body, RequestOptionsBase, ServiceCallback<TermList>) 

function update(listId: string, contentType: string, body: Body, options: RequestOptionsBase, callback: ServiceCallback<TermList>)

Parameters

listId

string

List Id of the image list.

contentType

string

The content type.

body
Body

Schema of the body.

options
RequestOptionsBase

The optional parameters

callback

ServiceCallback<TermList>

The callback

update(string, string, Body, ServiceCallback<TermList>) 

function update(listId: string, contentType: string, body: Body, callback: ServiceCallback<TermList>)

Parameters

listId

string

List Id of the image list.

contentType

string

The content type.

body
Body

Schema of the body.

callback

ServiceCallback<TermList>

The callback