WorkspaceItem
in package
implements
ModelInterface, ArrayAccess
WorkspaceItem Class Doc Comment
Tags
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
- getCallerAuthorization() : WorkspaceUserAuthorization
- Gets caller_authorization
- getContentType() : string|null
- Gets content_type
- getCreated() : string|null
- Gets created
- getCreatedById() : string|null
- Gets created_by_id
- getCreatedByInformation() : WorkspaceUser
- Gets created_by_information
- getExtension() : string|null
- Gets extension
- getFileSize() : string|null
- Gets file_size
- getFileUri() : string|null
- Gets file_uri
- getId() : string|null
- Gets id
- getIsPublic() : string|null
- Gets is_public
- getLastModified() : string|null
- Gets last_modified
- getLastModifiedById() : string|null
- Gets last_modified_by_id
- getLastModifiedByInformation() : WorkspaceUser
- Gets last_modified_by_information
- getModelName() : string
- The original name of the model.
- getName() : string|null
- Gets name
- getPageCount() : string|null
- Gets page_count
- getParentFolderId() : string|null
- Gets parent_folder_id
- getParentFolderUri() : string|null
- Gets parent_folder_uri
- getSha256() : string|null
- Gets sha256
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- getThumbHeight() : string|null
- Gets thumb_height
- getThumbnail() : Page
- Gets thumbnail
- getThumbWidth() : string|null
- Gets thumb_width
- getType() : string|null
- Gets type
- getUri() : string|null
- Gets uri
- getUserAuthorization() : WorkspaceUserAuthorization
- Gets user_authorization
- 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.
- setCallerAuthorization() : $this
- Sets caller_authorization
- setContentType() : $this
- Sets content_type
- setCreated() : $this
- Sets created
- setCreatedById() : $this
- Sets created_by_id
- setCreatedByInformation() : $this
- Sets created_by_information
- setExtension() : $this
- Sets extension
- setFileSize() : $this
- Sets file_size
- setFileUri() : $this
- Sets file_uri
- setId() : $this
- Sets id
- setIsPublic() : $this
- Sets is_public
- setLastModified() : $this
- Sets last_modified
- setLastModifiedById() : $this
- Sets last_modified_by_id
- setLastModifiedByInformation() : $this
- Sets last_modified_by_information
- setName() : $this
- Sets name
- setPageCount() : $this
- Sets page_count
- setParentFolderId() : $this
- Sets parent_folder_id
- setParentFolderUri() : $this
- Sets parent_folder_uri
- setSha256() : $this
- Sets sha256
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setThumbHeight() : $this
- Sets thumb_height
- setThumbnail() : $this
- Sets thumbnail
- setThumbWidth() : $this
- Sets thumb_width
- setType() : $this
- Sets type
- setUri() : $this
- Sets uri
- setUserAuthorization() : $this
- Sets user_authorization
- 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
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
= ['caller_authorization' => 'callerAuthorization', 'content_type' => 'contentType', 'created' => 'created', 'created_by_id' => 'createdById', 'created_by_information' => 'createdByInformation', 'extension' => 'extension', 'file_size' => 'fileSize', 'file_uri' => 'fileUri', 'id' => 'id', 'is_public' => 'isPublic', 'last_modified' => 'lastModified', 'last_modified_by_id' => 'lastModifiedById', 'last_modified_by_information' => 'lastModifiedByInformation', 'name' => 'name', 'page_count' => 'pageCount', 'parent_folder_id' => 'parentFolderId', 'parent_folder_uri' => 'parentFolderUri', 'sha256' => 'sha256', 'thumb_height' => 'thumbHeight', 'thumbnail' => 'thumbnail', 'thumb_width' => 'thumbWidth', 'type' => 'type', 'uri' => 'uri', 'user_authorization' => 'userAuthorization']
$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
= ['caller_authorization' => 'getCallerAuthorization', 'content_type' => 'getContentType', 'created' => 'getCreated', 'created_by_id' => 'getCreatedById', 'created_by_information' => 'getCreatedByInformation', 'extension' => 'getExtension', 'file_size' => 'getFileSize', 'file_uri' => 'getFileUri', 'id' => 'getId', 'is_public' => 'getIsPublic', 'last_modified' => 'getLastModified', 'last_modified_by_id' => 'getLastModifiedById', 'last_modified_by_information' => 'getLastModifiedByInformation', 'name' => 'getName', 'page_count' => 'getPageCount', 'parent_folder_id' => 'getParentFolderId', 'parent_folder_uri' => 'getParentFolderUri', 'sha256' => 'getSha256', 'thumb_height' => 'getThumbHeight', 'thumbnail' => 'getThumbnail', 'thumb_width' => 'getThumbWidth', 'type' => 'getType', 'uri' => 'getUri', 'user_authorization' => 'getUserAuthorization']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['caller_authorization' => 'setCallerAuthorization', 'content_type' => 'setContentType', 'created' => 'setCreated', 'created_by_id' => 'setCreatedById', 'created_by_information' => 'setCreatedByInformation', 'extension' => 'setExtension', 'file_size' => 'setFileSize', 'file_uri' => 'setFileUri', 'id' => 'setId', 'is_public' => 'setIsPublic', 'last_modified' => 'setLastModified', 'last_modified_by_id' => 'setLastModifiedById', 'last_modified_by_information' => 'setLastModifiedByInformation', 'name' => 'setName', 'page_count' => 'setPageCount', 'parent_folder_id' => 'setParentFolderId', 'parent_folder_uri' => 'setParentFolderUri', 'sha256' => 'setSha256', 'thumb_height' => 'setThumbHeight', 'thumbnail' => 'setThumbnail', 'thumb_width' => 'setThumbWidth', 'type' => 'setType', 'uri' => 'setUri', 'user_authorization' => 'setUserAuthorization']
$swaggerFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerFormats
= ['caller_authorization' => null, 'content_type' => null, 'created' => null, 'created_by_id' => null, 'created_by_information' => null, 'extension' => null, 'file_size' => null, 'file_uri' => null, 'id' => null, 'is_public' => null, 'last_modified' => null, 'last_modified_by_id' => null, 'last_modified_by_information' => null, 'name' => null, 'page_count' => null, 'parent_folder_id' => null, 'parent_folder_uri' => null, 'sha256' => null, 'thumb_height' => null, 'thumbnail' => null, 'thumb_width' => null, 'type' => null, 'uri' => null, 'user_authorization' => null]
$swaggerModelName
The original name of the model.
protected
static string
$swaggerModelName
= 'workspaceItem'
$swaggerTypes
Array of property to type mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerTypes
= ['caller_authorization' => '\\DocuSign\\eSign\\Model\\WorkspaceUserAuthorization', 'content_type' => '?string', 'created' => '?string', 'created_by_id' => '?string', 'created_by_information' => '\\DocuSign\\eSign\\Model\\WorkspaceUser', 'extension' => '?string', 'file_size' => '?string', 'file_uri' => '?string', 'id' => '?string', 'is_public' => '?string', 'last_modified' => '?string', 'last_modified_by_id' => '?string', 'last_modified_by_information' => '\\DocuSign\\eSign\\Model\\WorkspaceUser', 'name' => '?string', 'page_count' => '?string', 'parent_folder_id' => '?string', 'parent_folder_uri' => '?string', 'sha256' => '?string', 'thumb_height' => '?string', 'thumbnail' => '\\DocuSign\\eSign\\Model\\Page', 'thumb_width' => '?string', 'type' => '?string', 'uri' => '?string', 'user_authorization' => '\\DocuSign\\eSign\\Model\\WorkspaceUserAuthorization']
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> —getCallerAuthorization()
Gets caller_authorization
public
getCallerAuthorization() : WorkspaceUserAuthorization
Return values
WorkspaceUserAuthorization —getContentType()
Gets content_type
public
getContentType() : string|null
Return values
string|null —getCreated()
Gets created
public
getCreated() : string|null
Return values
string|null —getCreatedById()
Gets created_by_id
public
getCreatedById() : string|null
Return values
string|null —getCreatedByInformation()
Gets created_by_information
public
getCreatedByInformation() : WorkspaceUser
Return values
WorkspaceUser —getExtension()
Gets extension
public
getExtension() : string|null
Return values
string|null —getFileSize()
Gets file_size
public
getFileSize() : string|null
Return values
string|null —getFileUri()
Gets file_uri
public
getFileUri() : string|null
Return values
string|null —getId()
Gets id
public
getId() : string|null
Return values
string|null —getIsPublic()
Gets is_public
public
getIsPublic() : string|null
Return values
string|null —getLastModified()
Gets last_modified
public
getLastModified() : string|null
Return values
string|null —getLastModifiedById()
Gets last_modified_by_id
public
getLastModifiedById() : string|null
Return values
string|null —getLastModifiedByInformation()
Gets last_modified_by_information
public
getLastModifiedByInformation() : WorkspaceUser
Return values
WorkspaceUser —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getName()
Gets name
public
getName() : string|null
Return values
string|null —getPageCount()
Gets page_count
public
getPageCount() : string|null
Return values
string|null —getParentFolderId()
Gets parent_folder_id
public
getParentFolderId() : string|null
Return values
string|null —getParentFolderUri()
Gets parent_folder_uri
public
getParentFolderUri() : string|null
Return values
string|null —getSha256()
Gets sha256
public
getSha256() : string|null
Return values
string|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> —getThumbHeight()
Gets thumb_height
public
getThumbHeight() : string|null
Return values
string|null —getThumbnail()
Gets thumbnail
public
getThumbnail() : Page
Return values
Page —getThumbWidth()
Gets thumb_width
public
getThumbWidth() : string|null
Return values
string|null —getType()
Gets type
public
getType() : string|null
Return values
string|null —getUri()
Gets uri
public
getUri() : string|null
Return values
string|null —getUserAuthorization()
Gets user_authorization
public
getUserAuthorization() : WorkspaceUserAuthorization
Return values
WorkspaceUserAuthorization —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 —setCallerAuthorization()
Sets caller_authorization
public
setCallerAuthorization(WorkspaceUserAuthorization $caller_authorization) : $this
Parameters
- $caller_authorization : WorkspaceUserAuthorization
Return values
$this —setContentType()
Sets content_type
public
setContentType(string|null $content_type) : $this
Parameters
- $content_type : string|null
Return values
$this —setCreated()
Sets created
public
setCreated(string|null $created) : $this
Parameters
- $created : string|null
-
The UTC DateTime when the workspace item was created.
Return values
$this —setCreatedById()
Sets created_by_id
public
setCreatedById(string|null $created_by_id) : $this
Parameters
- $created_by_id : string|null
Return values
$this —setCreatedByInformation()
Sets created_by_information
public
setCreatedByInformation(WorkspaceUser $created_by_information) : $this
Parameters
- $created_by_information : WorkspaceUser
-
Details about the user who created the workspace item.
Return values
$this —setExtension()
Sets extension
public
setExtension(string|null $extension) : $this
Parameters
- $extension : string|null
Return values
$this —setFileSize()
Sets file_size
public
setFileSize(string|null $file_size) : $this
Parameters
- $file_size : string|null
Return values
$this —setFileUri()
Sets file_uri
public
setFileUri(string|null $file_uri) : $this
Parameters
- $file_uri : string|null
Return values
$this —setId()
Sets id
public
setId(string|null $id) : $this
Parameters
- $id : string|null
Return values
$this —setIsPublic()
Sets is_public
public
setIsPublic(string|null $is_public) : $this
Parameters
- $is_public : string|null
-
If true, this supersedes need for bit mask permission with workspaceUserAuthorization
Return values
$this —setLastModified()
Sets last_modified
public
setLastModified(string|null $last_modified) : $this
Parameters
- $last_modified : string|null
Return values
$this —setLastModifiedById()
Sets last_modified_by_id
public
setLastModifiedById(string|null $last_modified_by_id) : $this
Parameters
- $last_modified_by_id : string|null
-
Utc date and time the comment was last updated (can only be done by creator)
Return values
$this —setLastModifiedByInformation()
Sets last_modified_by_information
public
setLastModifiedByInformation(WorkspaceUser $last_modified_by_information) : $this
Parameters
- $last_modified_by_information : WorkspaceUser
-
Details about the user who last modified the workspace item.
Return values
$this —setName()
Sets name
public
setName(string|null $name) : $this
Parameters
- $name : string|null
-
A simple string description of the item, such as a file name or a folder name.
Return values
$this —setPageCount()
Sets page_count
public
setPageCount(string|null $page_count) : $this
Parameters
- $page_count : string|null
Return values
$this —setParentFolderId()
Sets parent_folder_id
public
setParentFolderId(string|null $parent_folder_id) : $this
Parameters
- $parent_folder_id : string|null
-
The ID of the parent folder. This is the GUID of the parent folder, or the special value 'root' for the root folder.
Return values
$this —setParentFolderUri()
Sets parent_folder_uri
public
setParentFolderUri(string|null $parent_folder_uri) : $this
Parameters
- $parent_folder_uri : string|null
Return values
$this —setSha256()
Sets sha256
public
setSha256(string|null $sha256) : $this
Parameters
- $sha256 : string|null
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> —setThumbHeight()
Sets thumb_height
public
setThumbHeight(string|null $thumb_height) : $this
Parameters
- $thumb_height : string|null
Return values
$this —setThumbnail()
Sets thumbnail
public
setThumbnail(Page $thumbnail) : $this
Parameters
- $thumbnail : Page
Return values
$this —setThumbWidth()
Sets thumb_width
public
setThumbWidth(string|null $thumb_width) : $this
Parameters
- $thumb_width : string|null
Return values
$this —setType()
Sets type
public
setType(string|null $type) : $this
Parameters
- $type : string|null
-
The type of the workspace item. Valid values are file, folder.
Return values
$this —setUri()
Sets uri
public
setUri(string|null $uri) : $this
Parameters
- $uri : string|null
Return values
$this —setUserAuthorization()
Sets user_authorization
public
setUserAuthorization(WorkspaceUserAuthorization $user_authorization) : $this
Parameters
- $user_authorization : WorkspaceUserAuthorization
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