PHPFUI/InstaDoc

Describes an event in the lifecycle of a payment transaction.

Generated from protobuf message google.cloud.recaptchaenterprise.v1.TransactionEvent

CloneableInstantiable

Extends
Google\Protobuf\Internal\Message

Public
Protected

Methods

public __construct( $data = NULL)

Constructor.

param array $data { Optional. Data for populating the Message object.

@type int $event_type
      Optional. The type of this transaction event.
@type string $reason
      Optional. The reason or standardized code that corresponds with this
      transaction event, if one exists. For example, a CHARGEBACK event with code
      6005.
@type float $value
      Optional. The value that corresponds with this transaction event, if one
      exists. For example, a refund event where $5.00 was refunded. Currency is
      obtained from the original transaction data.
@type \Google\Protobuf\Timestamp $event_time
      Optional. Timestamp when this transaction event occurred; otherwise assumed
      to be the time of the API call.

}

public Google\Protobuf\Internal\Message::__debugInfo()

public Google\Protobuf\Internal\Message::byteSize()

ignore

public Google\Protobuf\Internal\Message::clear()

Clear all containing fields.

return null

public clearEventTime()

public Google\Protobuf\Internal\Message::discardUnknownFields()

Clear all unknown fields previously parsed.

return null

public getEventTime()

Optional. Timestamp when this transaction event occurred; otherwise assumed to be the time of the API call.

Generated from protobuf field .google.protobuf.Timestamp event_time = 4 [(.google.api.field_behavior) = OPTIONAL];

return \Google\Protobuf\Timestamp|null

public getEventType()

Optional. The type of this transaction event.

Generated from protobuf field .google.cloud.recaptchaenterprise.v1.TransactionEvent.TransactionEventType event_type = 1 [(.google.api.field_behavior) = OPTIONAL];

return int

public getReason()

Optional. The reason or standardized code that corresponds with this transaction event, if one exists. For example, a CHARGEBACK event with code 6005.

Generated from protobuf field string reason = 2 [(.google.api.field_behavior) = OPTIONAL];

return string

public getValue()

Optional. The value that corresponds with this transaction event, if one exists. For example, a refund event where $5.00 was refunded. Currency is obtained from the original transaction data.

Generated from protobuf field double value = 3 [(.google.api.field_behavior) = OPTIONAL];

return float

public hasEventTime()

public Google\Protobuf\Internal\Message::jsonByteSize( $options = 0)

ignore

public Google\Protobuf\Internal\Message::mergeFrom( $msg)

Merges the contents of the specified message into current message.

This method merges the contents of the specified message into the current message. Singular fields that are set in the specified message overwrite the corresponding fields in the current message. Repeated fields are appended. Map fields key-value pairs are overwritten. Singular/Oneof sub-messages are recursively merged. All overwritten sub-messages are deep-copied.

param object $msg Protobuf message to be merged from.
return null

public Google\Protobuf\Internal\Message::mergeFromJsonString( $data, $ignore_unknown = false)

Parses a json string to protobuf message.

This function takes a string in the json wire format, matching the encoding output by serializeToJsonString(). See mergeFrom() for merging behavior, if the field is already set in the specified message.

param string $data Json protobuf data.
param bool $ignore_unknown
return null
throws \Exception Invalid data.

public Google\Protobuf\Internal\Message::mergeFromString( $data)

Parses a protocol buffer contained in a string.

This function takes a string in the (non-human-readable) binary wire format, matching the encoding output by serializeToString(). See mergeFrom() for merging behavior, if the field is already set in the specified message.

param string $data Binary protobuf data.
return null
throws \Exception Invalid data.

public Google\Protobuf\Internal\Message::parseFromJsonStream( $input, $ignore_unknown)

ignore

public Google\Protobuf\Internal\Message::parseFromStream( $input)

ignore

public Google\Protobuf\Internal\Message::serializeToJsonStream( $output)

ignore

public Google\Protobuf\Internal\Message::serializeToJsonString( $options = 0)

Serialize the message to json string.

return string Serialized json protobuf data.

public Google\Protobuf\Internal\Message::serializeToStream( $output)

ignore

public Google\Protobuf\Internal\Message::serializeToString()

Serialize the message to string.

return string Serialized binary protobuf data.

public setEventTime( $var)

Optional. Timestamp when this transaction event occurred; otherwise assumed to be the time of the API call.

Generated from protobuf field .google.protobuf.Timestamp event_time = 4 [(.google.api.field_behavior) = OPTIONAL];

param \Google\Protobuf\Timestamp $var
return $this

public setEventType( $var)

Optional. The type of this transaction event.

Generated from protobuf field .google.cloud.recaptchaenterprise.v1.TransactionEvent.TransactionEventType event_type = 1 [(.google.api.field_behavior) = OPTIONAL];

param int $var
return $this

public setReason( $var)

Optional. The reason or standardized code that corresponds with this transaction event, if one exists. For example, a CHARGEBACK event with code 6005.

Generated from protobuf field string reason = 2 [(.google.api.field_behavior) = OPTIONAL];

param string $var
return $this

public setValue( $var)

Optional. The value that corresponds with this transaction event, if one exists. For example, a refund event where $5.00 was refunded. Currency is obtained from the original transaction data.

Generated from protobuf field double value = 3 [(.google.api.field_behavior) = OPTIONAL];

param float $var
return $this

Properties

protected $event_time = NULL

Optional. Timestamp when this transaction event occurred; otherwise assumed to be the time of the API call.

Generated from protobuf field .google.protobuf.Timestamp event_time = 4 [(.google.api.field_behavior) = OPTIONAL];

protected $event_type = 0

Optional. The type of this transaction event.

Generated from protobuf field .google.cloud.recaptchaenterprise.v1.TransactionEvent.TransactionEventType event_type = 1 [(.google.api.field_behavior) = OPTIONAL];

protected $reason = ''

Optional. The reason or standardized code that corresponds with this transaction event, if one exists. For example, a CHARGEBACK event with code 6005.

Generated from protobuf field string reason = 2 [(.google.api.field_behavior) = OPTIONAL];

protected $value = 0

Optional. The value that corresponds with this transaction event, if one exists. For example, a refund event where $5.00 was refunded. Currency is obtained from the original transaction data.

Generated from protobuf field double value = 3 [(.google.api.field_behavior) = OPTIONAL];

Methods

protected Google\Protobuf\Internal\Message::hasOneof( $number)

protected Google\Protobuf\Internal\Message::mergeFromArray(array $array)

Populates the message from a user-supplied PHP array. Array keys correspond to Message properties and nested message properties.

Example:

$message->mergeFromArray([
    'name' => 'This is a message name',
    'interval' => [
         'startTime' => time() - 60,
         'endTime' => time(),
    ]
]);

This method will trigger an error if it is passed data that cannot be converted to the correct type. For example, a StringValue field must receive data that is either a string or a StringValue object.

param array $array An array containing message properties and values.
return null

protected Google\Protobuf\Internal\Message::mergeFromJsonArray( $array, $ignore_unknown)

protected Google\Protobuf\Internal\Message::readOneof( $number)

protected Google\Protobuf\Internal\Message::readWrapperValue( $member)

protected Google\Protobuf\Internal\Message::whichOneof( $oneof_name)

protected Google\Protobuf\Internal\Message::writeOneof( $number, $value)

protected Google\Protobuf\Internal\Message::writeWrapperValue( $member, $value)