GetSearchContentViewOptions

Kotlin |Java

class GetSearchContentViewOptions

---

This class contains all the options necessary to request search content UI view. Callers need to obtain a valid client ID before for response to be returned.

Summary

Public constructors
GetSearchContentViewOptions()

Public functions
GetSearchContentViewOptions!	@CanIgnoreReturnValue setClientId(clientId: String!) Specifies the client ID used to request the search content view.
GetSearchContentViewOptions!	@CanIgnoreReturnValue setNumberOfBlocksToRequest(numberOfBlocksToRequest: Int) Specifies the number of search content blocks requested.
GetSearchContentViewOptions!	@CanIgnoreReturnValue setSearchContentViewOptions(     searchContentViewOptions: SearchContentViewOptions! ) Sets the view options which provides the options to customize the search content UI view.
GetSearchContentViewOptions!	@CanIgnoreReturnValue setTextContext(textContext: (Mutable)List<String!>!) Specifies the text context of this request so that the returned search content will be related to a given list of texts.

Public constructors

GetSearchContentViewOptions

GetSearchContentViewOptions()

Public functions

setClientId

@CanIgnoreReturnValue
fun setClientId(clientId: String!): GetSearchContentViewOptions!

Specifies the client ID used to request the search content view.

Parameters
clientId: String!	the client ID to specify.

Returns
GetSearchContentViewOptions!	the current GetSearchContentViewOptions object.

setNumberOfBlocksToRequest

@CanIgnoreReturnValue
fun setNumberOfBlocksToRequest(numberOfBlocksToRequest: Int): GetSearchContentViewOptions!

Specifies the number of search content blocks requested.

Parameters
numberOfBlocksToRequest: Int	the number of search content blocks.

Returns
GetSearchContentViewOptions!	the current GetSearchContentViewOptions object.

setSearchContentViewOptions

@CanIgnoreReturnValue
fun setSearchContentViewOptions(
    searchContentViewOptions: SearchContentViewOptions!
): GetSearchContentViewOptions!

Sets the view options which provides the options to customize the search content UI view.

Parameters
searchContentViewOptions: SearchContentViewOptions!	the SearchContentViewOptions object used to customize the search content view.

Returns
GetSearchContentViewOptions!	the current GetSearchContentViewOptions object.

setTextContext

@CanIgnoreReturnValue
fun setTextContext(textContext: (Mutable)List<String!>!): GetSearchContentViewOptions!

Specifies the text context of this request so that the returned search content will be related to a given list of texts.

Parameters
textContext: (Mutable)List<String!>!	a list of texts to help generate search content.

Returns
GetSearchContentViewOptions!	the current GetSearchContentViewOptions object.