Nextcloud PHP API (master)

ICloudFederationShare
in

Interface ICloudFederationShare

Tags
since
14.0.0

Table of Contents

Methods

getDescription()  : string
get resource description (optional)
getOwner()  : string
get owner UID
getOwnerDisplayName()  : string
get owner display name
getProtocol()  : array<string|int, mixed>
get protocol specification
getProviderId()  : string
get provider ID (e.g. file ID)
getResourceName()  : string
get resource name (e.g. file, calendar, contact,...)
getResourceType()  : string
get resource type (e.g. file, calendar, contact,...)
getShare()  : array<string|int, mixed>
get the whole share, ready to send out
getSharedBy()  : string
get UID of the user who sends the share
getSharedByDisplayName()  : string
get display name of the user who sends the share
getShareSecret()  : string
get share Secret
getShareType()  : string
get share type (group or user)
getShareWith()  : string
get uid of the recipient
setDescription()  : mixed
set resource description (optional)
setOwner()  : mixed
set owner UID
setOwnerDisplayName()  : mixed
set owner display name
setProtocol()  : mixed
set protocol specification
setProviderId()  : mixed
set provider ID (e.g. file ID)
setResourceName()  : mixed
set resource name (e.g. file, calendar, contact,...)
setResourceType()  : mixed
set resource type (e.g. file, calendar, contact,...)
setSharedBy()  : mixed
set UID of the user who sends the share
setSharedByDisplayName()  : mixed
set display name of the user who sends the share
setShareType()  : mixed
share type (group or user)
setShareWith()  : mixed
set uid of the recipient

Methods

getDescription()

get resource description (optional)

public getDescription() : string
Tags
since
14.0.0
Return values
string

getOwnerDisplayName()

get owner display name

public getOwnerDisplayName() : string
Tags
since
14.0.0
Return values
string

getProtocol()

get protocol specification

public getProtocol() : array<string|int, mixed>
Tags
since
14.0.0
Return values
array<string|int, mixed>

getProviderId()

get provider ID (e.g. file ID)

public getProviderId() : string
Tags
since
14.0.0
Return values
string

getResourceName()

get resource name (e.g. file, calendar, contact,...)

public getResourceName() : string
Tags
since
14.0.0
Return values
string

getResourceType()

get resource type (e.g. file, calendar, contact,...)

public getResourceType() : string
Tags
since
14.0.0
Return values
string

getShare()

get the whole share, ready to send out

public getShare() : array<string|int, mixed>
Tags
since
14.0.0
Return values
array<string|int, mixed>

getSharedBy()

get UID of the user who sends the share

public getSharedBy() : string
Tags
since
14.0.0
Return values
string

getSharedByDisplayName()

get display name of the user who sends the share

public getSharedByDisplayName() : string
Tags
since
14.0.0
Return values
string

getShareSecret()

get share Secret

public getShareSecret() : string
Tags
since
14.0.0
Return values
string

getShareType()

get share type (group or user)

public getShareType() : string
Tags
since
14.0.0
Return values
string

getShareWith()

get uid of the recipient

public getShareWith() : string
Tags
since
14.0.0
Return values
string

setDescription()

set resource description (optional)

public setDescription(string $description) : mixed
Parameters
$description : string
Tags
since
14.0.0

setOwner()

set owner UID

public setOwner(string $owner) : mixed
Parameters
$owner : string
Tags
since
14.0.0

setOwnerDisplayName()

set owner display name

public setOwnerDisplayName(string $ownerDisplayName) : mixed
Parameters
$ownerDisplayName : string
Tags
since
14.0.0

setProtocol()

set protocol specification

public setProtocol(array<string|int, mixed> $protocol) : mixed
Parameters
$protocol : array<string|int, mixed>
Tags
since
14.0.0

setProviderId()

set provider ID (e.g. file ID)

public setProviderId(string $providerId) : mixed
Parameters
$providerId : string
Tags
since
14.0.0

setResourceName()

set resource name (e.g. file, calendar, contact,...)

public setResourceName(string $name) : mixed
Parameters
$name : string
Tags
since
14.0.0

setResourceType()

set resource type (e.g. file, calendar, contact,...)

public setResourceType(string $resourceType) : mixed
Parameters
$resourceType : string
Tags
since
14.0.0

setSharedBy()

set UID of the user who sends the share

public setSharedBy(string $sharedBy) : mixed
Parameters
$sharedBy : string
Tags
since
14.0.0

setSharedByDisplayName()

set display name of the user who sends the share

public setSharedByDisplayName(mixed $sharedByDisplayName) : mixed
Parameters
$sharedByDisplayName : mixed
Tags
since
14.0.0

setShareType()

share type (group or user)

public setShareType(string $shareType) : mixed
Parameters
$shareType : string
Tags
since
14.0.0

setShareWith()

set uid of the recipient

public setShareWith(string $user) : mixed
Parameters
$user : string
Tags
since
14.0.0 

        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results