Copied!

SessionServiceDecorator

SessionServiceDecorator.php : 21
Abstract
Implements SessionServiceInterface

Properties

protected $innerService

SessionServiceDecorator.php : 23 
protected SessionServiceInterface $innerService

Methods

public__construct()

SessionServiceDecorator.php : 25 
public __construct(SessionServiceInterface $innerService)

Parameters

Name Type Default value Description
$innerService SessionServiceInterface - -

publicaddParticipant()

SessionServiceDecorator.php : 60

Adds a participant to the collaboration session.

 
public addParticipant(SessionInterface $session, AbstractParticipantCreateStruct $createStruct) : ParticipantInterface

Parameters

Name Type Default value Description
$session SessionInterface - -
$createStruct AbstractParticipantCreateStruct - -

Return values

ParticipantInterface

publiccreateSession()

SessionServiceDecorator.php : 45

Creates a new collaboration session.

 
public createSession(AbstractSessionCreateStruct $createStruct) : SessionInterface

Parameters

Name Type Default value Description
$createStruct AbstractSessionCreateStruct - -

Return values

SessionInterface

publicdeleteSession()

SessionServiceDecorator.php : 55

Deletes an existing collaboration session.

 
public deleteSession(SessionInterface $session) : void

Parameters

Name Type Default value Description
$session SessionInterface - -

publicfindSessions()

SessionServiceDecorator.php : 40

Returns sessions matching the given query.

 
public findSessions([SessionQuery $query = null ]) : SessionListInterface

Parameters

Name Type Default value Description
$query SessionQuery null

Query used to fetch collaboration sessions

Return values

SessionListInterface

publicgetSession()

SessionServiceDecorator.php : 30

Returns collaboration session with given id.

 
public getSession(int $id) : SessionInterface

Parameters

Name Type Default value Description
$id int - -

Return values

SessionInterface

publicgetSessionByToken()

SessionServiceDecorator.php : 35

Returns collaboration session with given token.

 
public getSessionByToken(string $token) : SessionInterface

Parameters

Name Type Default value Description
$token string - -

Return values

SessionInterface

publicisSessionOwner()

SessionServiceDecorator.php : 80

Checks if user is a session owner. If user is not passed, the current user reference will be used for comparison.

 
public isSessionOwner(SessionInterface $session[, UserReference|null $user = null ]) : bool

Parameters

Name Type Default value Description
$session SessionInterface - -
$user UserReference|null null -

Return values

bool

publicisSessionParticipant()

SessionServiceDecorator.php : 85 
public isSessionParticipant(SessionInterface $session, UserReference $userReference) : bool

Parameters

Name Type Default value Description
$session SessionInterface - -
$userReference UserReference - -

Return values

bool

publicremoveParticipant()

SessionServiceDecorator.php : 75

Removes a participant from the collaboration session.

 
public removeParticipant(SessionInterface $session, ParticipantInterface $participant) : void

Parameters

Name Type Default value Description
$session SessionInterface - -
$participant ParticipantInterface - -

publicupdateParticipant()

SessionServiceDecorator.php : 67

Updates a participant data.

 
public updateParticipant(SessionInterface $session, ParticipantInterface $participant, AbstractParticipantUpdateStruct $updateStruct) : ParticipantInterface

Parameters

Name Type Default value Description
$session SessionInterface - -
$participant ParticipantInterface - -
$updateStruct AbstractParticipantUpdateStruct - -

Return values

ParticipantInterface

publicupdateSession()

SessionServiceDecorator.php : 50

Updates any existing collaboration session with the given data.

 
public updateSession(SessionInterface $session, AbstractSessionUpdateStruct $updateStruct) : SessionInterface

Parameters

Name Type Default value Description
$session SessionInterface - -
$updateStruct AbstractSessionUpdateStruct - -

Return values

SessionInterface