StickerMessageContent
        
        extends MessageContent
    
    
            
            in package
            
        
    
    
    
StickerMessageContent Class Doc Comment
Tags
Table of Contents
Constants
- DISCRIMINATOR = null
- STICKER_RESOURCE_TYPE__STATIC = 'STATIC'
- STICKER_RESOURCE_TYPE_ANIMATION = 'ANIMATION'
- STICKER_RESOURCE_TYPE_ANIMATION_SOUND = 'ANIMATION_SOUND'
- STICKER_RESOURCE_TYPE_CUSTOM = 'CUSTOM'
- STICKER_RESOURCE_TYPE_MESSAGE = 'MESSAGE'
- STICKER_RESOURCE_TYPE_NAME_TEXT = 'NAME_TEXT'
- STICKER_RESOURCE_TYPE_PER_STICKER_TEXT = 'PER_STICKER_TEXT'
- STICKER_RESOURCE_TYPE_POPUP = 'POPUP'
- STICKER_RESOURCE_TYPE_POPUP_SOUND = 'POPUP_SOUND'
- STICKER_RESOURCE_TYPE_SOUND = 'SOUND'
Properties
- $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, bool>
- Array of nullable properties. Used for (de)serialization
- $openAPINullablesSetToNull : array<string|int, bool>
- 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)
Methods
- __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
- getId() : string
- Gets id
- getKeywords() : array<string|int, string>|null
- Gets keywords
- getModelName() : string
- The original name of the model.
- getPackageId() : string
- Gets packageId
- getQuotedMessageId() : string|null
- Gets quotedMessageId
- getQuoteToken() : string
- Gets quoteToken
- getStickerId() : string
- Gets stickerId
- getStickerResourceType() : string
- Gets stickerResourceType
- getStickerResourceTypeAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- getText() : string|null
- Gets text
- getType() : string
- 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
- setId() : self
- Sets id
- setKeywords() : self
- Sets keywords
- setPackageId() : self
- Sets packageId
- setQuotedMessageId() : self
- Sets quotedMessageId
- setQuoteToken() : self
- Sets quoteToken
- setStickerId() : self
- Sets stickerId
- setStickerResourceType() : self
- Sets stickerResourceType
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setText() : self
- Sets text
- 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
    
    
    
    
STICKER_RESOURCE_TYPE__STATIC
    public
        mixed
    STICKER_RESOURCE_TYPE__STATIC
    = 'STATIC'
    
    
    
    
STICKER_RESOURCE_TYPE_ANIMATION
    public
        mixed
    STICKER_RESOURCE_TYPE_ANIMATION
    = 'ANIMATION'
    
    
    
    
STICKER_RESOURCE_TYPE_ANIMATION_SOUND
    public
        mixed
    STICKER_RESOURCE_TYPE_ANIMATION_SOUND
    = 'ANIMATION_SOUND'
    
    
    
    
STICKER_RESOURCE_TYPE_CUSTOM
    public
        mixed
    STICKER_RESOURCE_TYPE_CUSTOM
    = 'CUSTOM'
    
    
    
    
STICKER_RESOURCE_TYPE_MESSAGE
    public
        mixed
    STICKER_RESOURCE_TYPE_MESSAGE
    = 'MESSAGE'
    
    
    
    
STICKER_RESOURCE_TYPE_NAME_TEXT
    public
        mixed
    STICKER_RESOURCE_TYPE_NAME_TEXT
    = 'NAME_TEXT'
    
    
    
    
STICKER_RESOURCE_TYPE_PER_STICKER_TEXT
    public
        mixed
    STICKER_RESOURCE_TYPE_PER_STICKER_TEXT
    = 'PER_STICKER_TEXT'
    
    
    
    
STICKER_RESOURCE_TYPE_POPUP
    public
        mixed
    STICKER_RESOURCE_TYPE_POPUP
    = 'POPUP'
    
    
    
    
STICKER_RESOURCE_TYPE_POPUP_SOUND
    public
        mixed
    STICKER_RESOURCE_TYPE_POPUP_SOUND
    = 'POPUP_SOUND'
    
    
    
    
STICKER_RESOURCE_TYPE_SOUND
    public
        mixed
    STICKER_RESOURCE_TYPE_SOUND
    = 'SOUND'
    
    
    
    
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
     = ['packageId' => 'packageId', 'stickerId' => 'stickerId', 'stickerResourceType' => 'stickerResourceType', 'keywords' => 'keywords', 'text' => 'text', 'quoteToken' => 'quoteToken', 'quotedMessageId' => 'quotedMessageId']
    
    
    
    
    
$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
     = ['packageId' => 'getPackageId', 'stickerId' => 'getStickerId', 'stickerResourceType' => 'getStickerResourceType', 'keywords' => 'getKeywords', 'text' => 'getText', 'quoteToken' => 'getQuoteToken', 'quotedMessageId' => 'getQuotedMessageId']
    
    
    
    
    
$openAPIFormats
Array of property to format mappings. Used for (de)serialization
        protected
        static    array<string|int, string>
    $openAPIFormats
     = ['packageId' => null, 'stickerId' => null, 'stickerResourceType' => null, 'keywords' => null, 'text' => null, 'quoteToken' => null, 'quotedMessageId' => null]
    
    
    
    Tags
$openAPIModelName
The original name of the model.
        protected
        static    string
    $openAPIModelName
     = 'StickerMessageContent'
    
    
    
    
    
$openAPINullables
Array of nullable properties. Used for (de)serialization
        protected
        static    array<string|int, bool>
    $openAPINullables
     = ['packageId' => false, 'stickerId' => false, 'stickerResourceType' => false, 'keywords' => false, 'text' => false, 'quoteToken' => false, 'quotedMessageId' => false]
    
    
    
    
    
$openAPINullablesSetToNull
If a nullable field gets set to null, insert it here
        protected
            array<string|int, bool>
    $openAPINullablesSetToNull
     = []
    
    
    
    
    
$openAPITypes
Array of property to type mappings. Used for (de)serialization
        protected
        static    array<string|int, string>
    $openAPITypes
     = ['packageId' => 'string', 'stickerId' => 'string', 'stickerResourceType' => 'string', 'keywords' => 'string[]', 'text' => 'string', 'quoteToken' => 'string', 'quotedMessageId' => 'string']
    
    
    
    
    
$setters
Array of attributes to setter functions (for deserialization of responses)
        protected
        static    array<string|int, string>
    $setters
     = ['packageId' => 'setPackageId', 'stickerId' => 'setStickerId', 'stickerResourceType' => 'setStickerResourceType', 'keywords' => 'setKeywords', 'text' => 'setText', 'quoteToken' => 'setQuoteToken', 'quotedMessageId' => 'setQuotedMessageId']
    
    
    
    
    
Methods
__construct()
Constructor
    public
                    __construct([array<string|int, mixed>|null $data = null ]) : mixed
    Parameters
- $data : array<string|int, mixed>|null = null
- 
                    Associated array of property values initializing the model 
__toString()
Gets the string presentation of the object
    public
                    __toString() : string
    Return values
stringattributeMap()
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>getId()
Gets id
    public
                    getId() : string
    Return values
stringgetKeywords()
Gets keywords
    public
                    getKeywords() : array<string|int, string>|null
    Return values
array<string|int, string>|nullgetModelName()
The original name of the model.
    public
                    getModelName() : string
    Return values
stringgetPackageId()
Gets packageId
    public
                    getPackageId() : string
    Return values
stringgetQuotedMessageId()
Gets quotedMessageId
    public
                    getQuotedMessageId() : string|null
    Return values
string|nullgetQuoteToken()
Gets quoteToken
    public
                    getQuoteToken() : string
    Return values
stringgetStickerId()
Gets stickerId
    public
                    getStickerId() : string
    Return values
stringgetStickerResourceType()
Gets stickerResourceType
    public
                    getStickerResourceType() : string
    Return values
stringgetStickerResourceTypeAllowableValues()
Gets allowable values of the enum
    public
                    getStickerResourceTypeAllowableValues() : array<string|int, string>
    Return values
array<string|int, string>getters()
Array of attributes to getter functions (for serialization of requests)
    public
            static        getters() : array<string|int, mixed>
    Return values
array<string|int, mixed>getText()
Gets text
    public
                    getText() : string|null
    Return values
string|nullgetType()
Gets type
    public
                    getType() : string
    Return values
stringisNullable()
Checks if a property is nullable
    public
            static        isNullable(string $property) : bool
    Parameters
- $property : string
Return values
boolisNullableSetToNull()
Checks if a nullable property is set to null.
    public
                    isNullableSetToNull(string $property) : bool
    Parameters
- $property : string
Return values
booljsonSerialize()
Serializes the object to a value that can be serialized natively by json_encode().
    public
                    jsonSerialize() : mixed
    Tags
Attributes
- #[ReturnTypeWillChange]
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
booloffsetGet()
Gets offset.
    public
                    offsetGet(int $offset) : mixed|null
    Parameters
- $offset : int
- 
                    Offset 
Attributes
- #[ReturnTypeWillChange]
Return values
mixed|nulloffsetSet()
Sets value based on offset.
    public
                    offsetSet(int|null $offset, mixed $value) : void
    Parameters
- $offset : int|null
- 
                    Offset 
- $value : mixed
- 
                    Value to be set 
offsetUnset()
Unsets offset.
    public
                    offsetUnset(int $offset) : void
    Parameters
- $offset : int
- 
                    Offset 
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>setId()
Sets id
    public
                    setId(string $id) : self
    Parameters
- $id : string
- 
                    Message ID 
Return values
selfsetKeywords()
Sets keywords
    public
                    setKeywords(array<string|int, string>|null $keywords) : self
    Parameters
- $keywords : array<string|int, string>|null
- 
                    Array of up to 15 keywords describing the sticker. If a sticker has 16 or more keywords, a random selection of 15 keywords will be returned. The keyword selection is random for each event, so different keywords may be returned for the same sticker. 
Return values
selfsetPackageId()
Sets packageId
    public
                    setPackageId(string $packageId) : self
    Parameters
- $packageId : string
- 
                    Package ID 
Return values
selfsetQuotedMessageId()
Sets quotedMessageId
    public
                    setQuotedMessageId(string|null $quotedMessageId) : self
    Parameters
- $quotedMessageId : string|null
- 
                    Message ID of a quoted message. Only included when the received message quotes a past message. 
Return values
selfsetQuoteToken()
Sets quoteToken
    public
                    setQuoteToken(string $quoteToken) : self
    Parameters
- $quoteToken : string
- 
                    Quote token to quote this message. 
Return values
selfsetStickerId()
Sets stickerId
    public
                    setStickerId(string $stickerId) : self
    Parameters
- $stickerId : string
- 
                    Sticker ID 
Return values
selfsetStickerResourceType()
Sets stickerResourceType
    public
                    setStickerResourceType(string $stickerResourceType) : self
    Parameters
- $stickerResourceType : string
- 
                    stickerResourceType 
Return values
selfsetters()
Array of attributes to setter functions (for deserialization of responses)
    public
            static        setters() : array<string|int, mixed>
    Return values
array<string|int, mixed>setText()
Sets text
    public
                    setText(string|null $text) : self
    Parameters
- $text : string|null
- 
                    Any text entered by the user. This property is only included for message stickers. Max character limit: 100 
Return values
selfsetType()
Sets type
    public
                    setType(string $type) : self
    Parameters
- $type : string
- 
                    Type 
Return values
selftoHeaderValue()
Gets a header-safe presentation of the object
    public
                    toHeaderValue() : string
    Return values
stringvalid()
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
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>