AudienceGroup
in package
implements
ModelInterface, ArrayAccess, JsonSerializable
AudienceGroup Class Doc Comment
Tags
Interfaces, Classes, Traits and Enums
- ModelInterface
- Interface abstracting model access.
- ArrayAccess
- JsonSerializable
Table of Contents
- DISCRIMINATOR = null
- $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
- getAudienceCount() : int|null
- Gets audienceCount
- getAudienceGroupId() : int|null
- Gets audienceGroupId
- getClickUrl() : string|null
- Gets clickUrl
- getCreated() : int|null
- Gets created
- getCreateRoute() : AudienceGroupCreateRoute|null
- Gets createRoute
- getDescription() : string|null
- Gets description
- getFailedType() : AudienceGroupFailedType|null
- Gets failedType
- getIsIfaAudience() : bool|null
- Gets isIfaAudience
- getModelName() : string
- The original name of the model.
- getPermission() : AudienceGroupPermission|null
- Gets permission
- getRequestId() : string|null
- Gets requestId
- getStatus() : AudienceGroupStatus|null
- Gets status
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- getType() : AudienceGroupType|null
- Gets type
- 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
- setAudienceCount() : self
- Sets audienceCount
- setAudienceGroupId() : self
- Sets audienceGroupId
- setClickUrl() : self
- Sets clickUrl
- setCreated() : self
- Sets created
- setCreateRoute() : self
- Sets createRoute
- setDescription() : self
- Sets description
- setFailedType() : self
- Sets failedType
- setIsIfaAudience() : self
- Sets isIfaAudience
- setPermission() : self
- Sets permission
- setRequestId() : self
- Sets requestId
- setStatus() : self
- Sets status
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setType() : self
- Sets type
- 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
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
= ['audienceGroupId' => 'audienceGroupId', 'type' => 'type', 'description' => 'description', 'status' => 'status', 'failedType' => 'failedType', 'audienceCount' => 'audienceCount', 'created' => 'created', 'requestId' => 'requestId', 'clickUrl' => 'clickUrl', 'isIfaAudience' => 'isIfaAudience', 'permission' => 'permission', 'createRoute' => 'createRoute']
$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
= ['audienceGroupId' => 'getAudienceGroupId', 'type' => 'getType', 'description' => 'getDescription', 'status' => 'getStatus', 'failedType' => 'getFailedType', 'audienceCount' => 'getAudienceCount', 'created' => 'getCreated', 'requestId' => 'getRequestId', 'clickUrl' => 'getClickUrl', 'isIfaAudience' => 'getIsIfaAudience', 'permission' => 'getPermission', 'createRoute' => 'getCreateRoute']
$openAPIFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$openAPIFormats
= ['audienceGroupId' => 'int64', 'type' => null, 'description' => null, 'status' => null, 'failedType' => null, 'audienceCount' => 'int64', 'created' => 'int64', 'requestId' => null, 'clickUrl' => 'uri', 'isIfaAudience' => null, 'permission' => null, 'createRoute' => null]
Tags
$openAPIModelName
The original name of the model.
protected
static string
$openAPIModelName
= 'AudienceGroup'
$openAPINullables
Array of nullable properties. Used for (de)serialization
protected
static array<string|int, mixed>
$openAPINullables
= ['audienceGroupId' => false, 'type' => false, 'description' => false, 'status' => false, 'failedType' => true, 'audienceCount' => false, 'created' => false, 'requestId' => false, 'clickUrl' => false, 'isIfaAudience' => false, 'permission' => false, 'createRoute' => 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
= ['audienceGroupId' => 'int', 'type' => '\\LINE\\Clients\\ManageAudience\\Model\\AudienceGroupType', 'description' => 'string', 'status' => '\\LINE\\Clients\\ManageAudience\\Model\\AudienceGroupStatus', 'failedType' => '\\LINE\\Clients\\ManageAudience\\Model\\AudienceGroupFailedType', 'audienceCount' => 'int', 'created' => 'int', 'requestId' => 'string', 'clickUrl' => 'string', 'isIfaAudience' => 'bool', 'permission' => '\\LINE\\Clients\\ManageAudience\\Model\\AudienceGroupPermission', 'createRoute' => '\\LINE\\Clients\\ManageAudience\\Model\\AudienceGroupCreateRoute']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['audienceGroupId' => 'setAudienceGroupId', 'type' => 'setType', 'description' => 'setDescription', 'status' => 'setStatus', 'failedType' => 'setFailedType', 'audienceCount' => 'setAudienceCount', 'created' => 'setCreated', 'requestId' => 'setRequestId', 'clickUrl' => 'setClickUrl', 'isIfaAudience' => 'setIsIfaAudience', 'permission' => 'setPermission', 'createRoute' => 'setCreateRoute']
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> —getAudienceCount()
Gets audienceCount
public
getAudienceCount() : int|null
Return values
int|null —getAudienceGroupId()
Gets audienceGroupId
public
getAudienceGroupId() : int|null
Return values
int|null —getClickUrl()
Gets clickUrl
public
getClickUrl() : string|null
Return values
string|null —getCreated()
Gets created
public
getCreated() : int|null
Return values
int|null —getCreateRoute()
Gets createRoute
public
getCreateRoute() : AudienceGroupCreateRoute|null
Return values
AudienceGroupCreateRoute|null —getDescription()
Gets description
public
getDescription() : string|null
Return values
string|null —getFailedType()
Gets failedType
public
getFailedType() : AudienceGroupFailedType|null
Return values
AudienceGroupFailedType|null —getIsIfaAudience()
Gets isIfaAudience
public
getIsIfaAudience() : bool|null
Return values
bool|null —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getPermission()
Gets permission
public
getPermission() : AudienceGroupPermission|null
Return values
AudienceGroupPermission|null —getRequestId()
Gets requestId
public
getRequestId() : string|null
Return values
string|null —getStatus()
Gets status
public
getStatus() : AudienceGroupStatus|null
Return values
AudienceGroupStatus|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> —getType()
Gets type
public
getType() : AudienceGroupType|null
Return values
AudienceGroupType|null —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> —setAudienceCount()
Sets audienceCount
public
setAudienceCount(int|null $audienceCount) : self
Parameters
- $audienceCount : int|null
-
The number of users included in the audience.
Return values
self —setAudienceGroupId()
Sets audienceGroupId
public
setAudienceGroupId(int|null $audienceGroupId) : self
Parameters
- $audienceGroupId : int|null
-
The audience ID.
Return values
self —setClickUrl()
Sets clickUrl
public
setClickUrl(string|null $clickUrl) : self
Parameters
- $clickUrl : string|null
-
The URL that was specified when the audience was created. This is only included when
audienceGroup.typeis CLICK and link URL is specified.
Return values
self —setCreated()
Sets created
public
setCreated(int|null $created) : self
Parameters
- $created : int|null
-
When the audience was created (in UNIX time).
Return values
self —setCreateRoute()
Sets createRoute
public
setCreateRoute(AudienceGroupCreateRoute|null $createRoute) : self
Parameters
- $createRoute : AudienceGroupCreateRoute|null
-
createRoute
Return values
self —setDescription()
Sets description
public
setDescription(string|null $description) : self
Parameters
- $description : string|null
-
The audience's name.
Return values
self —setFailedType()
Sets failedType
public
setFailedType(AudienceGroupFailedType|null $failedType) : self
Parameters
- $failedType : AudienceGroupFailedType|null
-
failedType
Return values
self —setIsIfaAudience()
Sets isIfaAudience
public
setIsIfaAudience(bool|null $isIfaAudience) : self
Parameters
- $isIfaAudience : bool|null
-
The value indicating the type of account to be sent, as specified when creating the audience for uploading user IDs.
Return values
self —setPermission()
Sets permission
public
setPermission(AudienceGroupPermission|null $permission) : self
Parameters
- $permission : AudienceGroupPermission|null
-
permission
Return values
self —setRequestId()
Sets requestId
public
setRequestId(string|null $requestId) : self
Parameters
- $requestId : string|null
-
The request ID that was specified when the audience was created. This is only included when
audienceGroup.typeis CLICK or IMP.
Return values
self —setStatus()
Sets status
public
setStatus(AudienceGroupStatus|null $status) : self
Parameters
- $status : AudienceGroupStatus|null
-
status
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> —setType()
Sets type
public
setType(AudienceGroupType|null $type) : self
Parameters
- $type : AudienceGroupType|null
-
type
Return values
self —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>