ListSharedAccessOptions
in package
ListSharedAccessOptions Class Doc Comment
Tags
Table of Contents
- $count : string|null
- $count Specifies maximum number of results included in the response. If no value is specified, this defaults to 1000.
- $envelopes_not_shared_user_status : string|null
- $envelopes_not_shared_user_status
- $folder_ids : string|null
- $folder_ids
- $item_type : string|null
- $item_type Specifies the type of shared item being requested. The accepted values are: -envelopes: returns information about envelope sharing between users.
- $search_text : string|null
- $search_text This can be used to filter user names in the response. The wild-card '*' (asterisk) can be used around the string.
- $shared : string|null
- $shared Specifies which users should be included in the response. Multiple values can be used in the query by using a comma separated list of shared values. If the requestor does not have account administrator privileges, the shared_to value is used. Requestors that do not have account administrator privileges can only use the shared_to, any other setting will result in an error. The accepted values are: -not_shared: Returns account users that the specified item type is not being shared with and that are not sharing the specified item type with the user. User X (Share) X Account user -shared_to: Returns account users that the specified item type is not being shared with and who are sharing the specified item type with the user (only shared to the user). User X (Share) Account user -shared_from: Returns account users that the specified item type is being shared with and who are not sharing the specified item type with the user (only shared from the user). User (Share) >> Account user -shared_to_and_from: Returns account users that the specified item type is being shared with and who are sharing the specified item type with the user. User << (Share) >> Account user
- $start_position : string|null
- $start_position If the response set exceeds Count, this can be used to specify that the method should return users starting at the specified index. The first index is 0, and should be used in the first GET call. Typically this number is a multiple of Count. If no value is specified, this defaults to be 0.
- $user_ids : string|null
- $user_ids A comma separated list of userIds for whom the shared item information is being requested.
- getCount() : string|null
- Gets count
- getEnvelopesNotSharedUserStatus() : string|null
- Gets envelopes_not_shared_user_status
- getFolderIds() : string|null
- Gets folder_ids
- getItemType() : string|null
- Gets item_type
- getSearchText() : string|null
- Gets search_text
- getShared() : string|null
- Gets shared
- getStartPosition() : string|null
- Gets start_position
- getUserIds() : string|null
- Gets user_ids
- setCount() : self
- Sets count
- setEnvelopesNotSharedUserStatus() : self
- Sets envelopes_not_shared_user_status
- setFolderIds() : self
- Sets folder_ids
- setItemType() : self
- Sets item_type
- setSearchText() : self
- Sets search_text
- setShared() : self
- Sets shared
- setStartPosition() : self
- Sets start_position
- setUserIds() : self
- Sets user_ids
Properties
$count
$count Specifies maximum number of results included in the response. If no value is specified, this defaults to 1000.
protected
string|null
$count
= null
$envelopes_not_shared_user_status
$envelopes_not_shared_user_status
protected
string|null
$envelopes_not_shared_user_status
= null
$folder_ids
$folder_ids
protected
string|null
$folder_ids
= null
$item_type
$item_type Specifies the type of shared item being requested. The accepted values are: -envelopes: returns information about envelope sharing between users.
protected
string|null
$item_type
= null
$search_text
$search_text This can be used to filter user names in the response. The wild-card '*' (asterisk) can be used around the string.
protected
string|null
$search_text
= null
$shared
$shared Specifies which users should be included in the response. Multiple values can be used in the query by using a comma separated list of shared values. If the requestor does not have account administrator privileges, the shared_to value is used. Requestors that do not have account administrator privileges can only use the shared_to, any other setting will result in an error. The accepted values are: -not_shared: Returns account users that the specified item type is not being shared with and that are not sharing the specified item type with the user. User X (Share) X Account user -shared_to: Returns account users that the specified item type is not being shared with and who are sharing the specified item type with the user (only shared to the user). User X (Share) Account user -shared_from: Returns account users that the specified item type is being shared with and who are not sharing the specified item type with the user (only shared from the user). User (Share) >> Account user -shared_to_and_from: Returns account users that the specified item type is being shared with and who are sharing the specified item type with the user. User << (Share) >> Account user
protected
string|null
$shared
= null
$start_position
$start_position If the response set exceeds Count, this can be used to specify that the method should return users starting at the specified index. The first index is 0, and should be used in the first GET call. Typically this number is a multiple of Count. If no value is specified, this defaults to be 0.
protected
string|null
$start_position
= null
$user_ids
$user_ids A comma separated list of userIds for whom the shared item information is being requested.
protected
string|null
$user_ids
= null
Methods
getCount()
Gets count
public
getCount() : string|null
Return values
string|null —getEnvelopesNotSharedUserStatus()
Gets envelopes_not_shared_user_status
public
getEnvelopesNotSharedUserStatus() : string|null
Return values
string|null —getFolderIds()
Gets folder_ids
public
getFolderIds() : string|null
Return values
string|null —getItemType()
Gets item_type
public
getItemType() : string|null
Return values
string|null —getSearchText()
Gets search_text
public
getSearchText() : string|null
Return values
string|null —getShared()
Gets shared
public
getShared() : string|null
Return values
string|null —getStartPosition()
Gets start_position
public
getStartPosition() : string|null
Return values
string|null —getUserIds()
Gets user_ids
public
getUserIds() : string|null
Return values
string|null —setCount()
Sets count
public
setCount(string|null $count) : self
Parameters
- $count : string|null
-
Specifies maximum number of results included in the response. If no value is specified, this defaults to 1000.
Return values
self —setEnvelopesNotSharedUserStatus()
Sets envelopes_not_shared_user_status
public
setEnvelopesNotSharedUserStatus(string|null $envelopes_not_shared_user_status) : self
Parameters
- $envelopes_not_shared_user_status : string|null
Return values
self —setFolderIds()
Sets folder_ids
public
setFolderIds(string|null $folder_ids) : self
Parameters
- $folder_ids : string|null
Return values
self —setItemType()
Sets item_type
public
setItemType(string|null $item_type) : self
Parameters
- $item_type : string|null
-
Specifies the type of shared item being requested. The accepted values are: -envelopes: returns information about envelope sharing between users.
Return values
self —setSearchText()
Sets search_text
public
setSearchText(string|null $search_text) : self
Parameters
- $search_text : string|null
-
This can be used to filter user names in the response. The wild-card '*' (asterisk) can be used around the string.
Return values
self —setShared()
Sets shared
public
setShared(string|null $shared) : self
Parameters
- $shared : string|null
-
Specifies which users should be included in the response. Multiple values can be used in the query by using a comma separated list of shared values. If the requestor does not have account administrator privileges, the shared_to value is used. Requestors that do not have account administrator privileges can only use the shared_to, any other setting will result in an error. The accepted values are: -not_shared: Returns account users that the specified item type is not being shared with and that are not sharing the specified item type with the user. User X (Share) X Account user -shared_to: Returns account users that the specified item type is not being shared with and who are sharing the specified item type with the user (only shared to the user). User X (Share) Account user -shared_from: Returns account users that the specified item type is being shared with and who are not sharing the specified item type with the user (only shared from the user). User (Share) >> Account user -shared_to_and_from: Returns account users that the specified item type is being shared with and who are sharing the specified item type with the user. User << (Share) >> Account user
Return values
self —setStartPosition()
Sets start_position
public
setStartPosition(string|null $start_position) : self
Parameters
- $start_position : string|null
-
If the response set exceeds Count, this can be used to specify that the method should return users starting at the specified index. The first index is 0, and should be used in the first GET call. Typically this number is a multiple of Count. If no value is specified, this defaults to be 0.
Return values
self —setUserIds()
Sets user_ids
public
setUserIds(string|null $user_ids) : self
Parameters
- $user_ids : string|null
-
A comma separated list of userIds for whom the shared item information is being requested.