Events class

  • Reference
Package:
@azure/cognitiveservices-personalizer

Class representing a Events.

Constructors

Events(PersonalizerClientContext)

Create a Events.

Methods

activate(string, RequestOptionsBase)
activate(string, RequestOptionsBase, ServiceCallback<void>)
activate(string, ServiceCallback<void>)
reward(string, RewardRequest, RequestOptionsBase)
reward(string, RewardRequest, RequestOptionsBase, ServiceCallback<void>)
reward(string, RewardRequest, ServiceCallback<void>)

Constructor Details

Events(PersonalizerClientContext)

Create a Events.

new Events(client: PersonalizerClientContext)

Parameters

client
PersonalizerClientContext

Reference to the service client.

Method Details

activate(string, RequestOptionsBase) 

function activate(eventId: string, options?: RequestOptionsBase): Promise<RestResponse>

Parameters

eventId

string

The event ID this activation applies to.

options
RequestOptionsBase

The optional parameters

Returns

Promise<RestResponse>

Promise<msRest.RestResponse>

activate(string, RequestOptionsBase, ServiceCallback<void>) 

function activate(eventId: string, options: RequestOptionsBase, callback: ServiceCallback<void>)

Parameters

eventId

string

The event ID this activation applies to.

options
RequestOptionsBase

The optional parameters

callback

ServiceCallback<void>

The callback

activate(string, ServiceCallback<void>) 

function activate(eventId: string, callback: ServiceCallback<void>)

Parameters

eventId

string

The event ID this activation applies to.

callback

ServiceCallback<void>

The callback

reward(string, RewardRequest, RequestOptionsBase) 

function reward(eventId: string, rewardParameter: RewardRequest, options?: RequestOptionsBase): Promise<RestResponse>

Parameters

eventId

string

The event id this reward applies to.

rewardParameter
RewardRequest

The reward should be a floating point number.

options
RequestOptionsBase

The optional parameters

Returns

Promise<RestResponse>

Promise<msRest.RestResponse>

reward(string, RewardRequest, RequestOptionsBase, ServiceCallback<void>) 

function reward(eventId: string, rewardParameter: RewardRequest, options: RequestOptionsBase, callback: ServiceCallback<void>)

Parameters

eventId

string

The event id this reward applies to.

rewardParameter
RewardRequest

The reward should be a floating point number.

options
RequestOptionsBase

The optional parameters

callback

ServiceCallback<void>

The callback

reward(string, RewardRequest, ServiceCallback<void>) 

function reward(eventId: string, rewardParameter: RewardRequest, callback: ServiceCallback<void>)

Parameters

eventId

string

The event id this reward applies to.

rewardParameter
RewardRequest

The reward should be a floating point number.

callback

ServiceCallback<void>

The callback