SearchAction interface

Reference

Package:: @azure/cognitiveservices-autosuggest

An interface representing SearchAction.

Properties

about	For internal use only. NOTE: This property will not be serialized. It can only be populated by the server.
adaptiveCard	NOTE: This property will not be serialized. It can only be populated by the server.
commentCount	NOTE: This property will not be serialized. It can only be populated by the server.
copyrightHolder	NOTE: This property will not be serialized. It can only be populated by the server.
copyrightYear	NOTE: This property will not be serialized. It can only be populated by the server.
creator	NOTE: This property will not be serialized. It can only be populated by the server.
disclaimer	NOTE: This property will not be serialized. It can only be populated by the server.
discussionUrl	NOTE: This property will not be serialized. It can only be populated by the server.
displayName	NOTE: This property will not be serialized. It can only be populated by the server.
displayText	NOTE: This property will not be serialized. It can only be populated by the server.
genre	NOTE: This property will not be serialized. It can only be populated by the server.
headLine	NOTE: This property will not be serialized. It can only be populated by the server.
id	A String identifier. NOTE: This property will not be serialized. It can only be populated by the server.
immediateAction	NOTE: This property will not be serialized. It can only be populated by the server.
isAccessibleForFree	NOTE: This property will not be serialized. It can only be populated by the server.
isFamilyFriendly	NOTE: This property will not be serialized. It can only be populated by the server.
isTopAction	NOTE: This property will not be serialized. It can only be populated by the server.
mainEntity	NOTE: This property will not be serialized. It can only be populated by the server.
mentions	For internal use only. NOTE: This property will not be serialized. It can only be populated by the server.
potentialAction	NOTE: This property will not be serialized. It can only be populated by the server.
preferredClickthroughUrl	NOTE: This property will not be serialized. It can only be populated by the server.
provider	The source of the creative work. NOTE: This property will not be serialized. It can only be populated by the server.
query	NOTE: This property will not be serialized. It can only be populated by the server.
readLink	The URL that returns this resource. NOTE: This property will not be serialized. It can only be populated by the server.
result	NOTE: This property will not be serialized. It can only be populated by the server.
searchKind	Possible values include: 'WebSearch', 'HistorySearch', 'DocumentSearch', 'TagSearch', 'LocationSearch', 'CustomSearch' NOTE: This property will not be serialized. It can only be populated by the server.. Default value: 'WebSearch'.
serviceUrl	NOTE: This property will not be serialized. It can only be populated by the server.
text	Text content of this creative work NOTE: This property will not be serialized. It can only be populated by the server.
thumbnailUrl	The URL to a thumbnail of the item. NOTE: This property will not be serialized. It can only be populated by the server.
url	The URL to get more information about the thing represented by this object. NOTE: This property will not be serialized. It can only be populated by the server.
webSearchUrl	The URL To Bing's search result for this item. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

about

For internal use only. NOTE: This property will not be serialized. It can only be populated by the server.

about?: ThingUnion[]

Property Value

ThingUnion[]

adaptiveCard

NOTE: This property will not be serialized. It can only be populated by the server.

adaptiveCard?: string

Property Value

string

commentCount

NOTE: This property will not be serialized. It can only be populated by the server.

commentCount?: number

Property Value

number

copyrightHolder

NOTE: This property will not be serialized. It can only be populated by the server.

copyrightHolder?: ThingUnion

Property Value

ThingUnion

copyrightYear

NOTE: This property will not be serialized. It can only be populated by the server.

copyrightYear?: number

Property Value

number

creator

NOTE: This property will not be serialized. It can only be populated by the server.

creator?: ThingUnion

Property Value

ThingUnion

disclaimer

NOTE: This property will not be serialized. It can only be populated by the server.

disclaimer?: string

Property Value

string

discussionUrl

NOTE: This property will not be serialized. It can only be populated by the server.

discussionUrl?: string

Property Value

string

displayName

NOTE: This property will not be serialized. It can only be populated by the server.

displayName?: string

Property Value

string

displayText

NOTE: This property will not be serialized. It can only be populated by the server.

displayText?: string

Property Value

string

genre

NOTE: This property will not be serialized. It can only be populated by the server.

genre?: string[]

Property Value

string[]

headLine

NOTE: This property will not be serialized. It can only be populated by the server.

headLine?: string

Property Value

string

id

A String identifier. NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

immediateAction

NOTE: This property will not be serialized. It can only be populated by the server.

immediateAction?: ActionUnion[]

Property Value

ActionUnion[]

isAccessibleForFree

NOTE: This property will not be serialized. It can only be populated by the server.

isAccessibleForFree?: boolean

Property Value

boolean

isFamilyFriendly

NOTE: This property will not be serialized. It can only be populated by the server.

isFamilyFriendly?: boolean

Property Value

boolean

isTopAction

NOTE: This property will not be serialized. It can only be populated by the server.

isTopAction?: boolean

Property Value

boolean

mainEntity

NOTE: This property will not be serialized. It can only be populated by the server.

mainEntity?: ThingUnion

Property Value

ThingUnion

mentions

For internal use only. NOTE: This property will not be serialized. It can only be populated by the server.

mentions?: ThingUnion[]

Property Value

ThingUnion[]

potentialAction

NOTE: This property will not be serialized. It can only be populated by the server.

potentialAction?: ActionUnion[]

Property Value

ActionUnion[]

preferredClickthroughUrl

NOTE: This property will not be serialized. It can only be populated by the server.

preferredClickthroughUrl?: string

Property Value

string

provider

The source of the creative work. NOTE: This property will not be serialized. It can only be populated by the server.

provider?: ThingUnion[]

Property Value

ThingUnion[]

query

NOTE: This property will not be serialized. It can only be populated by the server.

query?: string

Property Value

string

readLink

The URL that returns this resource. NOTE: This property will not be serialized. It can only be populated by the server.

readLink?: string

Property Value

string

result

NOTE: This property will not be serialized. It can only be populated by the server.

result?: ThingUnion[]

Property Value

ThingUnion[]

searchKind

Possible values include: 'WebSearch', 'HistorySearch', 'DocumentSearch', 'TagSearch', 'LocationSearch', 'CustomSearch' NOTE: This property will not be serialized. It can only be populated by the server.. Default value: 'WebSearch'.

searchKind?: SearchKind

Property Value

SearchKind

serviceUrl

NOTE: This property will not be serialized. It can only be populated by the server.

serviceUrl?: string

Property Value

string

text

Text content of this creative work NOTE: This property will not be serialized. It can only be populated by the server.

text?: string

Property Value

string

thumbnailUrl

The URL to a thumbnail of the item. NOTE: This property will not be serialized. It can only be populated by the server.

thumbnailUrl?: string

Property Value

string

url

The URL to get more information about the thing represented by this object. NOTE: This property will not be serialized. It can only be populated by the server.

url?: string

Property Value

string

webSearchUrl

The URL To Bing's search result for this item. NOTE: This property will not be serialized. It can only be populated by the server.

webSearchUrl?: string

Property Value

string

Share via

SearchAction interface

Properties

Property Details

about

Property Value

adaptiveCard

Property Value

commentCount

Property Value

copyrightHolder

Property Value

copyrightYear

Property Value

creator

Property Value

disclaimer

Property Value

discussionUrl

Property Value

displayName

Property Value

displayText

Property Value

genre

Property Value

headLine

Property Value

id

Property Value

immediateAction

Property Value

isAccessibleForFree

Property Value

isFamilyFriendly

Property Value

isTopAction

Property Value

mainEntity

Property Value

mentions

Property Value

potentialAction

Property Value

preferredClickthroughUrl

Property Value

provider

Property Value

query

Property Value

readLink

Property Value

result

Property Value

searchKind

Property Value

serviceUrl

Property Value

text

Property Value

thumbnailUrl

Property Value

url

Property Value

webSearchUrl

Property Value

Additional resources