Documentation

CommentPublish
in package
implements ModelInterface, ArrayAccess

CommentPublish Class Doc Comment

Tags
category

Class

author

Swagger Codegen team apihelp@docusign.com

license

The Docusign PHP Client SDK is licensed under the MIT License.

link
https://github.com/swagger-api/swagger-codegen

Interfaces, Classes, Traits and Enums

ModelInterface
Interface abstracting model access.
ArrayAccess

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)
$setters  : array<string|int, string>
Array of attributes to setter functions (for deserialization of responses)
$swaggerFormats  : array<string|int, string>
Array of property to format mappings. Used for (de)serialization
$swaggerModelName  : string
The original name of the model.
$swaggerTypes  : array<string|int, string>
Array of property to type mappings. Used for (de)serialization
__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|null
Gets id
getMentions()  : array<string|int, ?string>
Gets mentions
getModelName()  : string
The original name of the model.
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getText()  : string|null
Gets text
getThreadAnchorKeys()  : mixed
Gets thread_anchor_keys
getThreadId()  : string|null
Gets thread_id
getVisibleTo()  : array<string|int, ?string>
Gets visible_to
listInvalidProperties()  : array<string|int, mixed>
Show all the invalid properties with reasons.
offsetExists()  : bool
Returns true if offset exists. False otherwise.
offsetGet()  : mixed
Gets offset.
offsetSet()  : void
Sets value based on offset.
offsetUnset()  : void
Unsets offset.
setId()  : $this
Sets id
setMentions()  : $this
Sets mentions
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setText()  : $this
Sets text
setThreadAnchorKeys()  : $this
Sets thread_anchor_keys
setThreadId()  : $this
Sets thread_id
setVisibleTo()  : $this
Sets visible_to
swaggerFormats()  : array<string|int, mixed>
Array of property to format mappings. Used for (de)serialization
swaggerTypes()  : array<string|int, mixed>
Array of property to type mappings. Used for (de)serialization
valid()  : bool
Validate all the properties in the model return true if all passed

Constants

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 = ['id' => 'id', 'mentions' => 'mentions', 'text' => 'text', 'thread_anchor_keys' => 'threadAnchorKeys', 'thread_id' => 'threadId', 'visible_to' => 'visibleTo']

$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 = ['id' => 'getId', 'mentions' => 'getMentions', 'text' => 'getText', 'thread_anchor_keys' => 'getThreadAnchorKeys', 'thread_id' => 'getThreadId', 'visible_to' => 'getVisibleTo']

$setters

Array of attributes to setter functions (for deserialization of responses)

protected static array<string|int, string> $setters = ['id' => 'setId', 'mentions' => 'setMentions', 'text' => 'setText', 'thread_anchor_keys' => 'setThreadAnchorKeys', 'thread_id' => 'setThreadId', 'visible_to' => 'setVisibleTo']

$swaggerFormats

Array of property to format mappings. Used for (de)serialization

protected static array<string|int, string> $swaggerFormats = ['id' => null, 'mentions' => null, 'text' => null, 'thread_anchor_keys' => null, 'thread_id' => null, 'visible_to' => null]

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'commentPublish'

$swaggerTypes

Array of property to type mappings. Used for (de)serialization

protected static array<string|int, string> $swaggerTypes = ['id' => '?string', 'mentions' => '?string[]', 'text' => '?string', 'thread_anchor_keys' => 'map[string,?string]', 'thread_id' => '?string', 'visible_to' => '?string[]']

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>

getId()

Gets id

public getId() : string|null
Return values
string|null

getMentions()

Gets mentions

public getMentions() : array<string|int, ?string>
Return values
array<string|int, ?string>

getModelName()

The original name of the model.

public getModelName() : string
Return values
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|null

getThreadAnchorKeys()

Gets thread_anchor_keys

public getThreadAnchorKeys() : mixed
Return values
mixed

getThreadId()

Gets thread_id

public getThreadId() : string|null
Return values
string|null

getVisibleTo()

Gets visible_to

public getVisibleTo() : array<string|int, ?string>
Return values
array<string|int, ?string>

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
Parameters
$offset : int

Offset

Return values
mixed

offsetSet()

Sets value based on offset.

public offsetSet(int $offset, mixed $value) : void
Parameters
$offset : int

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

setId()

Sets id

public setId(string|null $id) : $this
Parameters
$id : string|null
Return values
$this

setMentions()

Sets mentions

public setMentions(array<string|int, ?string> $mentions) : $this
Parameters
$mentions : array<string|int, ?string>
Return values
$this

setters()

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) : $this
Parameters
$text : string|null
Return values
$this

setThreadAnchorKeys()

Sets thread_anchor_keys

public setThreadAnchorKeys(mixed $thread_anchor_keys) : $this
Parameters
$thread_anchor_keys : mixed
Return values
$this

setThreadId()

Sets thread_id

public setThreadId(string|null $thread_id) : $this
Parameters
$thread_id : string|null
Return values
$this

setVisibleTo()

Sets visible_to

public setVisibleTo(array<string|int, ?string> $visible_to) : $this
Parameters
$visible_to : array<string|int, ?string>
Return values
$this

swaggerFormats()

Array of property to format mappings. Used for (de)serialization

public static swaggerFormats() : array<string|int, mixed>
Return values
array<string|int, mixed>

swaggerTypes()

Array of property to type mappings. Used for (de)serialization

public static swaggerTypes() : array<string|int, mixed>
Return values
array<string|int, mixed>

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

Search results