Nextcloud Circles API

SharingFrame
in package
implements JsonSerializable

Tags
deprecated

Class SharingFrame

Interfaces, Classes, Traits and Enums

JsonSerializable

Table of Contents

$author  : string
$circle  : DeprecatedCircle
$cloudId  : string
$creation  : int
$headers  : array<string|int, mixed>
$payload  : array<string|int, mixed>
$source  : string
$type  : string
$uniqueId  : string
__construct()  : mixed
cannotBeFromCircles()  : mixed
fromArray()  : mixed
fromJSON()  : mixed
generateUniqueId()  : SharingFrame
getAuthor()  : string
getCircle()  : DeprecatedCircle
getCloudId()  : string
getCreation()  : int
getHeader()  : string
getHeaders()  : array<string|int, mixed>|string
getPayload()  : array<string|int, mixed>|string
getSource()  : string
getType()  : string
getUniqueId()  : string
is0Circle()  : bool
isLocal()  : bool
jsonSerialize()  : mixed
setAuthor()  : mixed
setCircle()  : mixed
setCloudId()  : mixed
setCreation()  : mixed
setHeader()  : mixed
setHeaders()  : mixed
setPayload()  : mixed
setUniqueId()  : SharingFrame
getCircleFromArray()  : DeprecatedCircle
getHeadersFromArray()  : array<string|int, mixed>

Properties

Methods

__construct()

public __construct(mixed $source, mixed $type) : mixed
Parameters
$source : mixed
$type : mixed
Return values
mixed

fromArray()

public static fromArray(mixed $arr) : mixed
Parameters
$arr : mixed
Return values
mixed

fromJSON()

public static fromJSON(mixed $json) : mixed
Parameters
$json : mixed
Return values
mixed

getAuthor()

public getAuthor() : string
Return values
string

getCloudId()

public getCloudId() : string
Return values
string

getCreation()

public getCreation() : int
Return values
int

getHeader()

public getHeader(string $k) : string
Parameters
$k : string
Return values
string

getHeaders()

public getHeaders([bool $asJson = false ]) : array<string|int, mixed>|string
Parameters
$asJson : bool = false
Return values
array<string|int, mixed>|string

getPayload()

public getPayload([bool $asJson = false ]) : array<string|int, mixed>|string
Parameters
$asJson : bool = false
Return values
array<string|int, mixed>|string

getSource()

public getSource() : string
Return values
string

getType()

public getType() : string
Return values
string

getUniqueId()

public getUniqueId() : string
Return values
string

is0Circle()

public is0Circle() : bool
Return values
bool

isLocal()

public isLocal() : bool
Return values
bool

jsonSerialize()

public jsonSerialize() : mixed
Return values
mixed

setAuthor()

public setAuthor(string $author) : mixed
Parameters
$author : string
Return values
mixed

setCloudId()

public setCloudId(string $cloudId) : mixed
Parameters
$cloudId : string
Return values
mixed

setCreation()

public setCreation(int $creation) : mixed
Parameters
$creation : int
Return values
mixed

setHeader()

public setHeader(string $k, string $v) : mixed
Parameters
$k : string
$v : string
Return values
mixed

setHeaders()

public setHeaders(array<string|int, mixed> $headers) : mixed
Parameters
$headers : array<string|int, mixed>
Return values
mixed

setPayload()

public setPayload(array<string|int, mixed> $payload) : mixed
Parameters
$payload : array<string|int, mixed>
Return values
mixed

getHeadersFromArray()

private static getHeadersFromArray(array<string|int, mixed> $arr) : array<string|int, mixed>
Parameters
$arr : array<string|int, mixed>
Return values
array<string|int, mixed>

Search results