ListManagementImageLists class

Package:

@azure/cognitiveservices-contentmoderator

Class representing a ListManagementImageLists.

Constructors

ListManagementImageLists(ContentModeratorClientContext)

Create a ListManagementImageLists.

Methods

create(string, Body, RequestOptionsBase)	Creates an image list.
create(string, Body, RequestOptionsBase, ServiceCallback<ImageList>)
create(string, Body, ServiceCallback<ImageList>)
deleteMethod(string, RequestOptionsBase)	Deletes image list with the list Id equal to list Id passed.
deleteMethod(string, RequestOptionsBase, ServiceCallback<string>)
deleteMethod(string, ServiceCallback<string>)
getAllImageLists(RequestOptionsBase)	Gets all the Image Lists.
getAllImageLists(RequestOptionsBase, ServiceCallback<ImageList[]>)
getAllImageLists(ServiceCallback<ImageList[]>)
getDetails(string, RequestOptionsBase)	Returns the details of the image list with list Id equal to list Id passed.
getDetails(string, RequestOptionsBase, ServiceCallback<ImageList>)
getDetails(string, ServiceCallback<ImageList>)
refreshIndexMethod(string, RequestOptionsBase)	Refreshes the index of the list with list Id equal to list Id passed.
refreshIndexMethod(string, RequestOptionsBase, ServiceCallback<RefreshIndex>)
refreshIndexMethod(string, ServiceCallback<RefreshIndex>)
update(string, string, Body, RequestOptionsBase)	Updates an image list with list Id equal to list Id passed.
update(string, string, Body, RequestOptionsBase, ServiceCallback<ImageList>)
update(string, string, Body, ServiceCallback<ImageList>)

Constructor Details

ListManagementImageLists(ContentModeratorClientContext)

Create a ListManagementImageLists.

new ListManagementImageLists(client: ContentModeratorClientContext)

Parameters

client

ContentModeratorClientContext

Reference to the service client.

Method Details

create(string, Body, RequestOptionsBase)

Creates an image list.

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

Parameters

contentType

string

The content type.

body

Body

Schema of the body.

options

RequestOptionsBase

The optional parameters

Returns

Promise<ListManagementImageListsCreateResponse>

Promise<Models.ListManagementImageListsCreateResponse>

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

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

Parameters

contentType

string

The content type.

body

Body

Schema of the body.

options

RequestOptionsBase

The optional parameters

callback

ServiceCallback<ImageList>

The callback

create(string, Body, ServiceCallback<ImageList>)

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

Parameters

contentType

string

The content type.

body

Body

Schema of the body.

callback

ServiceCallback<ImageList>

The callback

deleteMethod(string, RequestOptionsBase)

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

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

Parameters

listId

string

List Id of the image list.

options

RequestOptionsBase

The optional parameters

Returns

Promise<ListManagementImageListsDeleteMethodResponse>

Promise<Models.ListManagementImageListsDeleteMethodResponse>

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

getAllImageLists(RequestOptionsBase)

Gets all the Image Lists.

function getAllImageLists(options?: RequestOptionsBase): Promise<ListManagementImageListsGetAllImageListsResponse>

Parameters

options

RequestOptionsBase

The optional parameters

Returns

Promise<ListManagementImageListsGetAllImageListsResponse>

Promise<Models.ListManagementImageListsGetAllImageListsResponse>

getAllImageLists(RequestOptionsBase, ServiceCallback<ImageList[]>)

function getAllImageLists(options: RequestOptionsBase, callback: ServiceCallback<ImageList[]>)

Parameters

options

RequestOptionsBase

The optional parameters

callback

ServiceCallback<ImageList[]>

The callback

getAllImageLists(ServiceCallback<ImageList[]>)

function getAllImageLists(callback: ServiceCallback<ImageList[]>)

Parameters

callback

ServiceCallback<ImageList[]>

The callback

getDetails(string, RequestOptionsBase)

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

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

Parameters

listId

string

List Id of the image list.

options

RequestOptionsBase

The optional parameters

Returns

Promise<ListManagementImageListsGetDetailsResponse>

Promise<Models.ListManagementImageListsGetDetailsResponse>

getDetails(string, RequestOptionsBase, ServiceCallback<ImageList>)

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

Parameters

listId

string

List Id of the image list.

options

RequestOptionsBase

The optional parameters

callback

ServiceCallback<ImageList>

The callback

getDetails(string, ServiceCallback<ImageList>)

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

Parameters

listId

string

List Id of the image list.

callback

ServiceCallback<ImageList>

The callback

refreshIndexMethod(string, RequestOptionsBase)

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

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

Parameters

listId

string

List Id of the image list.

options

RequestOptionsBase

The optional parameters

Returns

Promise<ListManagementImageListsRefreshIndexMethodResponse>

Promise<Models.ListManagementImageListsRefreshIndexMethodResponse>

refreshIndexMethod(string, RequestOptionsBase, ServiceCallback<RefreshIndex>)

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

Parameters

listId

string

List Id of the image list.

options

RequestOptionsBase

The optional parameters

callback

ServiceCallback<RefreshIndex>

The callback

refreshIndexMethod(string, ServiceCallback<RefreshIndex>)

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

Parameters

listId

string

List Id of the image list.

callback

ServiceCallback<RefreshIndex>

The callback

update(string, string, Body, RequestOptionsBase)

Updates an image list with list Id equal to list Id passed.

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

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<ListManagementImageListsUpdateResponse>

Promise<Models.ListManagementImageListsUpdateResponse>

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

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

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<ImageList>

The callback

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

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

Parameters

listId

string

List Id of the image list.

contentType

string

The content type.

body

Body

Schema of the body.

callback

ServiceCallback<ImageList>

The callback