Nextcloud PHP API (master)

IReference extends JsonSerializable
in

Tags
since
25.0.0

Table of Contents

Methods

getAccessible()  : bool
Accessible flag indicates if the user has access to the provided reference
getDescription()  : string|null
getId()  : string
getImageContentType()  : string|null
getImageUrl()  : string|null
getOpenGraphObject()  : array<string|int, mixed>
Returns the opengraph rich object representation
getRichObject()  : array<string|int, mixed>
Returns the reference specific rich object representation
getRichObjectType()  : string
Returns the type of the reference specific rich object
getTitle()  : string
getUrl()  : string
jsonSerialize()  : array{richObjectType: string, richObject: array, openGraphObject: array{id: string, name: string, description: ?string, thumb: ?string, link: string}, accessible: bool}
setAccessible()  : void
Accessible flag indicates if the user has access to the provided reference
setDescription()  : void
setImageContentType()  : void
setImageUrl()  : void
setRichObject()  : void
Set the reference specific rich object representation
setTitle()  : void
setUrl()  : void

Methods

getAccessible()

Accessible flag indicates if the user has access to the provided reference

public getAccessible() : bool
Tags
since
25.0.0
Return values
bool

getDescription()

public getDescription() : string|null
Tags
since
25.0.0
Return values
string|null

getId()

public getId() : string
Tags
since
25.0.0
Return values
string

getImageContentType()

public getImageContentType() : string|null
Tags
since
25.0.0
Return values
string|null

getImageUrl()

public getImageUrl() : string|null
Tags
since
25.0.0
Return values
string|null

getOpenGraphObject()

Returns the opengraph rich object representation

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

getRichObject()

Returns the reference specific rich object representation

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

getRichObjectType()

Returns the type of the reference specific rich object

public getRichObjectType() : string
Tags
since
25.0.0
Return values
string

getTitle()

public getTitle() : string
Tags
since
25.0.0
Return values
string

getUrl()

public getUrl() : string
Tags
since
25.0.0
Return values
string

jsonSerialize()

public jsonSerialize() : array{richObjectType: string, richObject: array, openGraphObject: array{id: string, name: string, description: ?string, thumb: ?string, link: string}, accessible: bool}
Tags
since
25.0.0
Return values
array{richObjectType: string, richObject: array, openGraphObject: array{id: string, name: string, description: ?string, thumb: ?string, link: string}, accessible: bool}

setAccessible()

Accessible flag indicates if the user has access to the provided reference

public setAccessible(bool $accessible) : void
Parameters
$accessible : bool
Tags
since
25.0.0

setDescription()

public setDescription(string|null $description) : void
Parameters
$description : string|null
Tags
since
25.0.0

setImageContentType()

public setImageContentType(string|null $contentType) : void
Parameters
$contentType : string|null
Tags
since
25.0.0

setImageUrl()

public setImageUrl(string|null $imageUrl) : void
Parameters
$imageUrl : string|null
Tags
since
25.0.0

setRichObject()

Set the reference specific rich object representation

public setRichObject(string $type, array<string|int, mixed>|null $richObject) : void
Parameters
$type : string
$richObject : array<string|int, mixed>|null
Tags
since
25.0.0

setTitle()

public setTitle(string $title) : void
Parameters
$title : string
Tags
since
25.0.0

setUrl()

public setUrl(string|null $url) : void
Parameters
$url : string|null
Tags
since
25.0.0 

        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results