ShareLink
extends Share
in package
Class representing a public link to a resource
Table of Contents
Methods
- delete() : bool
- Permanently delete the current share or share link
- getDisplayName() : string
- getDriveId() : string
- getExpiration() : DateTimeImmutable|null
- getPermissionId() : string
- getResourceId() : string
- getSharingLink() : SharingLink
- getType() : SharingLinkType
- getWebUrl() : string
- setDisplayName() : bool
- setExpiration() : bool
- Change the Expiration date for the current share or share link Set to null to remove the expiration date
- setPassword() : bool
- setType() : bool
- Change the type of the current ShareLink.
- updateLinkOfPermission() : true
Methods
delete()
Permanently delete the current share or share link
public
delete() : bool
Tags
Return values
boolgetDisplayName()
public
getDisplayName() : string
Return values
stringgetDriveId()
public
getDriveId() : string
Return values
stringgetExpiration()
public
getExpiration() : DateTimeImmutable|null
Return values
DateTimeImmutable|nullgetPermissionId()
public
getPermissionId() : string
Return values
stringgetResourceId()
public
getResourceId() : string
Return values
stringgetSharingLink()
public
getSharingLink() : SharingLink
Return values
SharingLinkgetType()
public
getType() : SharingLinkType
Return values
SharingLinkTypegetWebUrl()
public
getWebUrl() : string
Return values
stringsetDisplayName()
public
setDisplayName(string $displayName) : bool
Parameters
- $displayName : string
Tags
Return values
boolsetExpiration()
Change the Expiration date for the current share or share link Set to null to remove the expiration date
public
setExpiration(DateTimeImmutable|null $expiration) : bool
Parameters
- $expiration : DateTimeImmutable|null
Tags
Return values
boolsetPassword()
public
setPassword(string $password) : bool
Parameters
- $password : string
-
It may require a password policy. Set to empty sting to remove the password.
Tags
Return values
boolsetType()
Change the type of the current ShareLink.
public
setType(SharingLinkType $linkType) : bool
For details about the possible types see https://owncloud.dev/libre-graph-api/#/drives.permissions/CreateLink Types of share links are not to be confused with roles for shares!
Parameters
- $linkType : SharingLinkType
Tags
Return values
boolupdateLinkOfPermission()
public
updateLinkOfPermission() : true