Copied!

InvitationServiceInterface

InvitationServiceInterface.php : 21
Interface

Service for managing collaboration sessions invitations.

Methods

publiccreateInvitation()

InvitationServiceInterface.php : 50

Creates a new invitation.

 
public createInvitation(InvitationCreateStruct $createStruct) : InvitationInterface

Parameters

Name Type Default value Description
$createStruct InvitationCreateStruct - -

Return values

InvitationInterface

Tags
Throws
UnauthorizedException

If the user does not have permission to create the invitation.

Throws
InvalidArgumentException

If the invitation create struct is invalid.

publicdeleteInvitation()

InvitationServiceInterface.php : 72

Deletes an invitation.

 
public deleteInvitation(InvitationInterface $invitation) : void

Parameters

Name Type Default value Description
$invitation InvitationInterface - -
Tags
Throws
NotFoundException

If the invitation does not exist.

Throws
UnauthorizedException

If the user does not have permission to delete the invitation.

publicfindInvitations()

InvitationServiceInterface.php : 42

Returns invitations matching the given query.

 
public findInvitations([InvitationQuery|null $query = null ]) : InvitationListInterface

Parameters

Name Type Default value Description
$query InvitationQuery|null null -

Return values

InvitationListInterface

publicgetInvitation()

InvitationServiceInterface.php : 29

Returns an invitation with given ID.

 
public getInvitation(int $id) : InvitationInterface

Parameters

Name Type Default value Description
$id int - -

Return values

InvitationInterface

Tags
Throws
NotFoundException

If invitation with given ID does not exist.

Throws
UnauthorizedException

If the user does not have permission to view the invitation.

publicgetInvitationByParticipant()

InvitationServiceInterface.php : 37

Returns an invitation associated with the given participant.

 
public getInvitationByParticipant(ParticipantInterface $participant) : InvitationInterface

Parameters

Name Type Default value Description
$participant ParticipantInterface - -

Return values

InvitationInterface

Tags
Throws
NotFoundException

If the invitation does not exist.

Throws
UnauthorizedException

If the user does not have permission to view the invitation.

publicupdateInvitation()

InvitationServiceInterface.php : 61

Updates any existing invitation with the given data.

 
public updateInvitation(InvitationInterface $invitation, InvitationUpdateStruct $updateStruct) : InvitationInterface

Parameters

Name Type Default value Description
$invitation InvitationInterface - -
$updateStruct InvitationUpdateStruct - -

Return values

InvitationInterface

Tags
Throws
NotFoundException

If the invitation does not exist.

Throws
UnauthorizedException

If the user does not have permission to update the invitation.

Throws
InvalidArgumentException

If the invitation update struct is invalid.