ListManagementTerm class

Package:

@azure/cognitiveservices-contentmoderator

Class representing a ListManagementTerm.

Constructors

ListManagementTerm(ContentModeratorClientContext)

Create a ListManagementTerm.

Methods

addTerm(string, string, string, RequestOptionsBase)	Add a term to the term list with list Id equal to list Id passed.
addTerm(string, string, string, RequestOptionsBase, ServiceCallback<void>)
addTerm(string, string, string, ServiceCallback<void>)
deleteAllTerms(string, string, RequestOptionsBase)	Deletes all terms from the list with list Id equal to the list Id passed.
deleteAllTerms(string, string, RequestOptionsBase, ServiceCallback<string>)
deleteAllTerms(string, string, ServiceCallback<string>)
deleteTerm(string, string, string, RequestOptionsBase)	Deletes a term from the list with list Id equal to the list Id passed.
deleteTerm(string, string, string, RequestOptionsBase, ServiceCallback<string>)
deleteTerm(string, string, string, ServiceCallback<string>)
getAllTerms(string, string, ListManagementTermGetAllTermsOptionalParams)	Gets all terms from the list with list Id equal to the list Id passed.
getAllTerms(string, string, ListManagementTermGetAllTermsOptionalParams, ServiceCallback<Terms>)
getAllTerms(string, string, ServiceCallback<Terms>)

Constructor Details

ListManagementTerm(ContentModeratorClientContext)

Create a ListManagementTerm.

new ListManagementTerm(client: ContentModeratorClientContext)

Parameters

client

ContentModeratorClientContext

Reference to the service client.

Method Details

addTerm(string, string, string, RequestOptionsBase)

Add a term to the term list with list Id equal to list Id passed.

function addTerm(listId: string, term: string, language: string, options?: RequestOptionsBase): Promise<RestResponse>

Parameters

listId

string

List Id of the image list.

term

string

Term to be deleted

language

string

Language of the terms.

options

RequestOptionsBase

The optional parameters

Returns

Promise<RestResponse>

Promise<msRest.RestResponse>

addTerm(string, string, string, RequestOptionsBase, ServiceCallback<void>)

function addTerm(listId: string, term: string, language: string, options: RequestOptionsBase, callback: ServiceCallback<void>)

Parameters

listId

string

List Id of the image list.

term

string

Term to be deleted

language

string

Language of the terms.

options

RequestOptionsBase

The optional parameters

callback

ServiceCallback<void>

The callback

addTerm(string, string, string, ServiceCallback<void>)

function addTerm(listId: string, term: string, language: string, callback: ServiceCallback<void>)

Parameters

listId

string

List Id of the image list.

term

string

Term to be deleted

language

string

Language of the terms.

callback

ServiceCallback<void>

The callback

deleteAllTerms(string, string, RequestOptionsBase)

Deletes all terms from the list with list Id equal to the list Id passed.

function deleteAllTerms(listId: string, language: string, options?: RequestOptionsBase): Promise<ListManagementTermDeleteAllTermsResponse>

Parameters

listId

string

List Id of the image list.

language

string

Language of the terms.

options

RequestOptionsBase

The optional parameters

Returns

Promise<ListManagementTermDeleteAllTermsResponse>

Promise<Models.ListManagementTermDeleteAllTermsResponse>

deleteAllTerms(string, string, RequestOptionsBase, ServiceCallback<string>)

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

Parameters

listId

string

List Id of the image list.

language

string

Language of the terms.

options

RequestOptionsBase

The optional parameters

callback

ServiceCallback<string>

The callback

deleteAllTerms(string, string, ServiceCallback<string>)

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

Parameters

listId

string

List Id of the image list.

language

string

Language of the terms.

callback

ServiceCallback<string>

The callback

deleteTerm(string, string, string, RequestOptionsBase)

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

function deleteTerm(listId: string, term: string, language: string, options?: RequestOptionsBase): Promise<ListManagementTermDeleteTermResponse>

Parameters

listId

string

List Id of the image list.

term

string

Term to be deleted

language

string

Language of the terms.

options

RequestOptionsBase

The optional parameters

Returns

Promise<ListManagementTermDeleteTermResponse>

Promise<Models.ListManagementTermDeleteTermResponse>

deleteTerm(string, string, string, RequestOptionsBase, ServiceCallback<string>)

function deleteTerm(listId: string, term: string, language: string, options: RequestOptionsBase, callback: ServiceCallback<string>)

Parameters

listId

string

List Id of the image list.

term

string

Term to be deleted

language

string

Language of the terms.

options

RequestOptionsBase

The optional parameters

callback

ServiceCallback<string>

The callback

deleteTerm(string, string, string, ServiceCallback<string>)

function deleteTerm(listId: string, term: string, language: string, callback: ServiceCallback<string>)

Parameters

listId

string

List Id of the image list.

term

string

Term to be deleted

language

string

Language of the terms.

callback

ServiceCallback<string>

The callback

getAllTerms(string, string, ListManagementTermGetAllTermsOptionalParams)

Gets all terms from the list with list Id equal to the list Id passed.

function getAllTerms(listId: string, language: string, options?: ListManagementTermGetAllTermsOptionalParams): Promise<ListManagementTermGetAllTermsResponse>

Parameters

listId

string

List Id of the image list.

language

string

Language of the terms.

options

ListManagementTermGetAllTermsOptionalParams

The optional parameters

Returns

Promise<ListManagementTermGetAllTermsResponse>

Promise<Models.ListManagementTermGetAllTermsResponse>

getAllTerms(string, string, ListManagementTermGetAllTermsOptionalParams, ServiceCallback<Terms>)

function getAllTerms(listId: string, language: string, options: ListManagementTermGetAllTermsOptionalParams, callback: ServiceCallback<Terms>)

Parameters

listId

string

List Id of the image list.

language

string

Language of the terms.

options

ListManagementTermGetAllTermsOptionalParams

The optional parameters

callback

ServiceCallback<Terms>

The callback

getAllTerms(string, string, ServiceCallback<Terms>)

function getAllTerms(listId: string, language: string, callback: ServiceCallback<Terms>)

Parameters

listId

string

List Id of the image list.

language

string

Language of the terms.

callback

ServiceCallback<Terms>

The callback