ShareReviewEntry
in package
Holds a single app-managed share as exposed to a share-review app through {@see IShareReviewSource::getShares()}.
Tags
Attributes
- #[Consumable]
- $since: '34.0.2'
Table of Contents
Properties
- $action : string
- $expirationTimestamp : int|null
- $hasPassword : bool
- $id : string
- $initiator : string
- $lastModifiedTimestamp : int
- $object : string
- $parent : string|null
- $permissions : array<string|int, mixed>
- $recipient : string
- $type : int
Methods
- __construct() : mixed
Properties
$action read-only
public
string
$action
= ''
$expirationTimestamp read-only
public
int|null
$expirationTimestamp
= null
$hasPassword read-only
public
bool
$hasPassword
= false
$id read-only
public
string
$id
$initiator read-only
public
string
$initiator
$lastModifiedTimestamp read-only
public
int
$lastModifiedTimestamp
$object read-only
public
string
$object
$parent read-only
public
string|null
$parent
= null
$permissions read-only
public
array<string|int, mixed>
$permissions
= []
$recipient read-only
public
string
$recipient
$type read-only
public
int
$type
Methods
__construct()
public
__construct(string $id, string $object, string $initiator, IShare::TYPE_* $type, string $recipient, int $lastModifiedTimestamp[, array<int, ShareReviewPermission> $permissions = [] ][, string $action = '' ][, bool $hasPassword = false ][, int|null $expirationTimestamp = null ][, string|null $parent = null ]) : mixed
Parameters
- $id : string
-
Unique app-specific identifier for the share, passed to IShareReviewSource::deleteShare().
- $object : string
-
Name or title of the shared object, such as a file path or report name.
- $initiator : string
-
User ID of the initiator.
- $type : IShare::TYPE_*
-
IShare type of the share.
- $recipient : string
-
User ID of the owner or the token of a link.
- $lastModifiedTimestamp : int
-
Unix timestamp of the share's creation or last modification, whichever is later; used for sorting and for the new-since-last-review filter. Pass 0 if the app tracks neither.
- $permissions : array<int, ShareReviewPermission> = []
-
Permissions granted by the share. An empty list means the share grants nothing beyond existing.
- $action : string = ''
-
Optional deletion identifier override. An empty string means $id is used.
- $hasPassword : bool = false
-
Whether the share is password protected. Never the password itself.
- $expirationTimestamp : int|null = null
-
Optional expiration Unix timestamp of the share.
- $parent : string|null = null
-
Optional identifier of the parent share.