NarrowcastProgressResponse
in package
implements
ModelInterface, ArrayAccess, JsonSerializable
NarrowcastProgressResponse Class Doc Comment
Tags
Interfaces, Classes, Traits and Enums
- ModelInterface
- Interface abstracting model access.
- ArrayAccess
- JsonSerializable
Table of Contents
- DISCRIMINATOR = null
- PHASE_FAILED = 'failed'
- PHASE_SENDING = 'sending'
- PHASE_SUCCEEDED = 'succeeded'
- PHASE_WAITING = 'waiting'
- $attributeMap : array<string|int, string>
- Array of attributes where the key is the local name, and the value is the original name
- $container : array<string|int, mixed>
- Associative array for storing property values
- $getters : array<string|int, string>
- Array of attributes to getter functions (for serialization of requests)
- $openAPIFormats : array<string|int, string>
- Array of property to format mappings. Used for (de)serialization
- $openAPIModelName : string
- The original name of the model.
- $openAPINullables : array<string|int, mixed>
- Array of nullable properties. Used for (de)serialization
- $openAPINullablesSetToNull : array<string|int, mixed>
- If a nullable field gets set to null, insert it here
- $openAPITypes : array<string|int, string>
- Array of property to type mappings. Used for (de)serialization
- $setters : array<string|int, string>
- Array of attributes to setter functions (for deserialization of responses)
- __construct() : mixed
- Constructor
- __toString() : string
- Gets the string presentation of the object
- attributeMap() : array<string|int, mixed>
- Array of attributes where the key is the local name, and the value is the original name
- getAcceptedTime() : DateTime
- Gets acceptedTime
- getCompletedTime() : DateTime|null
- Gets completedTime
- getErrorCode() : int|null
- Gets errorCode
- getFailedDescription() : string|null
- Gets failedDescription
- getFailureCount() : int|null
- Gets failureCount
- getModelName() : string
- The original name of the model.
- getPhase() : string
- Gets phase
- getPhaseAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getSuccessCount() : int|null
- Gets successCount
- getTargetCount() : int|null
- Gets targetCount
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- isNullable() : bool
- Checks if a property is nullable
- isNullableSetToNull() : bool
- Checks if a nullable property is set to null.
- jsonSerialize() : mixed
- Serializes the object to a value that can be serialized natively by json_encode().
- listInvalidProperties() : array<string|int, mixed>
- Show all the invalid properties with reasons.
- offsetExists() : bool
- Returns true if offset exists. False otherwise.
- offsetGet() : mixed|null
- Gets offset.
- offsetSet() : void
- Sets value based on offset.
- offsetUnset() : void
- Unsets offset.
- openAPIFormats() : array<string|int, mixed>
- Array of property to format mappings. Used for (de)serialization
- openAPITypes() : array<string|int, mixed>
- Array of property to type mappings. Used for (de)serialization
- setAcceptedTime() : self
- Sets acceptedTime
- setCompletedTime() : self
- Sets completedTime
- setErrorCode() : self
- Sets errorCode
- setFailedDescription() : self
- Sets failedDescription
- setFailureCount() : self
- Sets failureCount
- setPhase() : self
- Sets phase
- setSuccessCount() : self
- Sets successCount
- setTargetCount() : self
- Sets targetCount
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- toHeaderValue() : string
- Gets a header-safe presentation of the object
- valid() : bool
- Validate all the properties in the model return true if all passed
- openAPINullables() : array<string|int, mixed>
- Array of nullable properties
- getOpenAPINullablesSetToNull() : array<string|int, bool>
- Array of nullable field names deliberately set to null
- setIfExists() : void
- Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the $this->openAPINullablesSetToNull array
- setOpenAPINullablesSetToNull() : void
- Setter - Array of nullable field names deliberately set to null
Constants
DISCRIMINATOR
public
mixed
DISCRIMINATOR
= null
PHASE_FAILED
public
mixed
PHASE_FAILED
= 'failed'
PHASE_SENDING
public
mixed
PHASE_SENDING
= 'sending'
PHASE_SUCCEEDED
public
mixed
PHASE_SUCCEEDED
= 'succeeded'
PHASE_WAITING
public
mixed
PHASE_WAITING
= 'waiting'
Properties
$attributeMap
Array of attributes where the key is the local name, and the value is the original name
protected
static array<string|int, string>
$attributeMap
= ['phase' => 'phase', 'successCount' => 'successCount', 'failureCount' => 'failureCount', 'targetCount' => 'targetCount', 'failedDescription' => 'failedDescription', 'errorCode' => 'errorCode', 'acceptedTime' => 'acceptedTime', 'completedTime' => 'completedTime']
$container
Associative array for storing property values
protected
array<string|int, mixed>
$container
= []
$getters
Array of attributes to getter functions (for serialization of requests)
protected
static array<string|int, string>
$getters
= ['phase' => 'getPhase', 'successCount' => 'getSuccessCount', 'failureCount' => 'getFailureCount', 'targetCount' => 'getTargetCount', 'failedDescription' => 'getFailedDescription', 'errorCode' => 'getErrorCode', 'acceptedTime' => 'getAcceptedTime', 'completedTime' => 'getCompletedTime']
$openAPIFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$openAPIFormats
= ['phase' => null, 'successCount' => 'int64', 'failureCount' => 'int64', 'targetCount' => 'int64', 'failedDescription' => null, 'errorCode' => 'int64', 'acceptedTime' => 'date-time', 'completedTime' => 'date-time']
Tags
$openAPIModelName
The original name of the model.
protected
static string
$openAPIModelName
= 'NarrowcastProgressResponse'
$openAPINullables
Array of nullable properties. Used for (de)serialization
protected
static array<string|int, mixed>
$openAPINullables
= ['phase' => false, 'successCount' => false, 'failureCount' => false, 'targetCount' => false, 'failedDescription' => false, 'errorCode' => false, 'acceptedTime' => false, 'completedTime' => false]
$openAPINullablesSetToNull
If a nullable field gets set to null, insert it here
protected
array<string|int, mixed>
$openAPINullablesSetToNull
= []
$openAPITypes
Array of property to type mappings. Used for (de)serialization
protected
static array<string|int, string>
$openAPITypes
= ['phase' => 'string', 'successCount' => 'int', 'failureCount' => 'int', 'targetCount' => 'int', 'failedDescription' => 'string', 'errorCode' => 'int', 'acceptedTime' => '\\DateTime', 'completedTime' => '\\DateTime']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['phase' => 'setPhase', 'successCount' => 'setSuccessCount', 'failureCount' => 'setFailureCount', 'targetCount' => 'setTargetCount', 'failedDescription' => 'setFailedDescription', 'errorCode' => 'setErrorCode', 'acceptedTime' => 'setAcceptedTime', 'completedTime' => 'setCompletedTime']
Methods
__construct()
Constructor
public
__construct([array<string|int, mixed> $data = null ]) : mixed
Parameters
- $data : array<string|int, mixed> = null
-
Associated array of property values initializing the model
Return values
mixed —__toString()
Gets the string presentation of the object
public
__toString() : string
Return values
string —attributeMap()
Array of attributes where the key is the local name, and the value is the original name
public
static attributeMap() : array<string|int, mixed>
Return values
array<string|int, mixed> —getAcceptedTime()
Gets acceptedTime
public
getAcceptedTime() : DateTime
Return values
DateTime —getCompletedTime()
Gets completedTime
public
getCompletedTime() : DateTime|null
Return values
DateTime|null —getErrorCode()
Gets errorCode
public
getErrorCode() : int|null
Return values
int|null —getFailedDescription()
Gets failedDescription
public
getFailedDescription() : string|null
Return values
string|null —getFailureCount()
Gets failureCount
public
getFailureCount() : int|null
Return values
int|null —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getPhase()
Gets phase
public
getPhase() : string
Return values
string —getPhaseAllowableValues()
Gets allowable values of the enum
public
getPhaseAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getSuccessCount()
Gets successCount
public
getSuccessCount() : int|null
Return values
int|null —getTargetCount()
Gets targetCount
public
getTargetCount() : int|null
Return values
int|null —getters()
Array of attributes to getter functions (for serialization of requests)
public
static getters() : array<string|int, mixed>
Return values
array<string|int, mixed> —isNullable()
Checks if a property is nullable
public
static isNullable(string $property) : bool
Parameters
- $property : string
Return values
bool —isNullableSetToNull()
Checks if a nullable property is set to null.
public
isNullableSetToNull(string $property) : bool
Parameters
- $property : string
Return values
bool —jsonSerialize()
Serializes the object to a value that can be serialized natively by json_encode().
public
jsonSerialize() : mixed
Tags
Return values
mixed —Returns data which can be serialized by json_encode(), which is a value of any type other than a resource.
listInvalidProperties()
Show all the invalid properties with reasons.
public
listInvalidProperties() : array<string|int, mixed>
Return values
array<string|int, mixed> —invalid properties with reasons
offsetExists()
Returns true if offset exists. False otherwise.
public
offsetExists(int $offset) : bool
Parameters
- $offset : int
-
Offset
Return values
bool —offsetGet()
Gets offset.
public
offsetGet(int $offset) : mixed|null
Parameters
- $offset : int
-
Offset
Return values
mixed|null —offsetSet()
Sets value based on offset.
public
offsetSet(int|null $offset, mixed $value) : void
Parameters
- $offset : int|null
-
Offset
- $value : mixed
-
Value to be set
Return values
void —offsetUnset()
Unsets offset.
public
offsetUnset(int $offset) : void
Parameters
- $offset : int
-
Offset
Return values
void —openAPIFormats()
Array of property to format mappings. Used for (de)serialization
public
static openAPIFormats() : array<string|int, mixed>
Return values
array<string|int, mixed> —openAPITypes()
Array of property to type mappings. Used for (de)serialization
public
static openAPITypes() : array<string|int, mixed>
Return values
array<string|int, mixed> —setAcceptedTime()
Sets acceptedTime
public
setAcceptedTime(DateTime $acceptedTime) : self
Parameters
- $acceptedTime : DateTime
-
Narrowcast message request accepted time in milliseconds. Format: ISO 8601 (e.g. 2020-12-03T10:15:30.121Z) Timezone: UTC
Return values
self —setCompletedTime()
Sets completedTime
public
setCompletedTime(DateTime|null $completedTime) : self
Parameters
- $completedTime : DateTime|null
-
Processing of narrowcast message request completion time in milliseconds. Returned when the phase property is succeeded or failed. Format: ISO 8601 (e.g. 2020-12-03T10:15:30.121Z) Timezone: UTC
Return values
self —setErrorCode()
Sets errorCode
public
setErrorCode(int|null $errorCode) : self
Parameters
- $errorCode : int|null
-
Error summary. This is only included with a phase property value of failed. One of:
1
: An internal error occurred.2
: An error occurred because there weren't enough recipients.3
: A conflict error of requests occurs because a request that has already been accepted is retried.
Return values
self —setFailedDescription()
Sets failedDescription
public
setFailedDescription(string|null $failedDescription) : self
Parameters
- $failedDescription : string|null
-
The reason the message failed to be sent. This is only included with a
phase
property value offailed
.
Return values
self —setFailureCount()
Sets failureCount
public
setFailureCount(int|null $failureCount) : self
Parameters
- $failureCount : int|null
-
The number of users who failed to send the message.
Return values
self —setPhase()
Sets phase
public
setPhase(string $phase) : self
Parameters
- $phase : string
-
The current status. One of:
waiting
: Messages are not yet ready to be sent. They are currently being filtered or processed in some way.sending
: Messages are currently being sent.succeeded
: Messages were sent successfully. This may not mean the messages were successfully received.failed
: Messages failed to be sent. Use the failedDescription property to find the cause of the failure.
Return values
self —setSuccessCount()
Sets successCount
public
setSuccessCount(int|null $successCount) : self
Parameters
- $successCount : int|null
-
The number of users who successfully received the message.
Return values
self —setTargetCount()
Sets targetCount
public
setTargetCount(int|null $targetCount) : self
Parameters
- $targetCount : int|null
-
The number of intended recipients of the message.
Return values
self —setters()
Array of attributes to setter functions (for deserialization of responses)
public
static setters() : array<string|int, mixed>
Return values
array<string|int, mixed> —toHeaderValue()
Gets a header-safe presentation of the object
public
toHeaderValue() : string
Return values
string —valid()
Validate all the properties in the model return true if all passed
public
valid() : bool
Return values
bool —True if all properties are valid
openAPINullables()
Array of nullable properties
protected
static openAPINullables() : array<string|int, mixed>
Return values
array<string|int, mixed> —getOpenAPINullablesSetToNull()
Array of nullable field names deliberately set to null
private
getOpenAPINullablesSetToNull() : array<string|int, bool>
Return values
array<string|int, bool> —setIfExists()
Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the $this->openAPINullablesSetToNull array
private
setIfExists(string $variableName, array<string|int, mixed> $fields, mixed $defaultValue) : void
Parameters
- $variableName : string
- $fields : array<string|int, mixed>
- $defaultValue : mixed
Return values
void —setOpenAPINullablesSetToNull()
Setter - Array of nullable field names deliberately set to null
private
setOpenAPINullablesSetToNull(array<string|int, bool> $openAPINullablesSetToNull) : void
Parameters
- $openAPINullablesSetToNull : array<string|int, bool>