Nextcloud PHP API (master)

IRoom

Interface IRoom

Tags
since
14.0.0

Table of Contents

Methods

getBackend()  : IBackend
Get corresponding backend object
getDisplayName()  : string
Get the display name for the room
getEMail()  : string
Get the email-address for the room
getGroupRestrictions()  : array<string|int, string>
Get a list of groupIds that are allowed to access this room
getId()  : string
Get a unique ID for the room

Methods

getBackend()

Get corresponding backend object

public getBackend() : IBackend
Tags
since
14.0.0
Return values
IBackend

getDisplayName()

Get the display name for the room

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

getEMail()

Get the email-address for the room

public getEMail() : string

The email-address has to be globally unique

Tags
since
14.0.0
Return values
string

getGroupRestrictions()

Get a list of groupIds that are allowed to access this room

public getGroupRestrictions() : array<string|int, string>

If an empty array is returned, no group restrictions are applied.

Tags
since
14.0.0
Return values
array<string|int, string>

getId()

Get a unique ID for the room

public getId() : string

This id has to be unique within the backend

Tags
since
14.0.0
Return values
string

        
On this page

Search results