Class protos.google.cloud.recaptchaenterprise.v1beta1.Event (2.1.7)

Represents an Event.

Package

@google-cloud/recaptcha-enterprise!

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.recaptchaenterprise.v1beta1.IEvent);

Constructs a new Event.

Parameter
Name Description
properties IEvent

Properties to set

Properties

expectedAction

public expectedAction: string;

Event expectedAction.

Property Value
Type Description
string

siteKey

public siteKey: string;

Event siteKey.

Property Value
Type Description
string

token

public token: string;

Event token.

Property Value
Type Description
string

userAgent

public userAgent: string;

Event userAgent.

Property Value
Type Description
string

userIpAddress

public userIpAddress: string;

Event userIpAddress.

Property Value
Type Description
string

Methods

create(properties)

public static create(properties?: google.cloud.recaptchaenterprise.v1beta1.IEvent): google.cloud.recaptchaenterprise.v1beta1.Event;

Creates a new Event instance using the specified properties.

Parameter
Name Description
properties IEvent

Properties to set
Returns
Type Description
google.cloud.recaptchaenterprise.v1beta1.Event

Event instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.recaptchaenterprise.v1beta1.Event;

Decodes an Event message from the specified reader or buffer.

Parameters
Name Description
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from
length number

Message length if known beforehand
Returns
Type Description
google.cloud.recaptchaenterprise.v1beta1.Event

Event

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.recaptchaenterprise.v1beta1.Event;

Decodes an Event message from the specified reader or buffer, length delimited.

Parameter
Name Description
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from
Returns
Type Description
google.cloud.recaptchaenterprise.v1beta1.Event

Event

encode(message, writer)

public static encode(message: google.cloud.recaptchaenterprise.v1beta1.IEvent, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Event message. Does not implicitly messages.

Parameters
Name Description
message IEvent

Event message or plain object to encode
writer $protobuf.Writer

Writer to encode to
Returns
Type Description
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.recaptchaenterprise.v1beta1.IEvent, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Event message, length delimited. Does not implicitly messages.

Parameters
Name Description
message IEvent

Event message or plain object to encode
writer $protobuf.Writer

Writer to encode to
Returns
Type Description
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.recaptchaenterprise.v1beta1.Event;

Creates an Event message from a plain object. Also converts values to their respective internal types.

Parameter
Name Description
object { [k: string]: any }

Plain object
Returns
Type Description
google.cloud.recaptchaenterprise.v1beta1.Event

Event

toJSON()

public toJSON(): { [k: string]: any };

Converts this Event to JSON.

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.cloud.recaptchaenterprise.v1beta1.Event, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from an Event message. Also converts values to other types if specified.

Parameters
Name Description
message google.cloud.recaptchaenterprise.v1beta1.Event

Event
options $protobuf.IConversionOptions

Conversion options
Returns
Type Description
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies an Event message.

Parameter
Name Description
message { [k: string]: any }

Plain object to verify
Returns
Type Description
(string|null)

null if valid, otherwise the reason why it is not