Bitrix API

CollabService

FinalYes

Table of Contents

Methods

__construct()  : mixed
getCollabByStorage()  : Collab|null
Returns the collaboration entity by the storage.
getCollabStorageByEntity()  : Storage|null
Returns the collaboration storage by the entity.
isCollabEntity()  : bool
Returns true if the entity is a collaboration entity.
isCollaberUserById()  : bool
Returns true if the user is a collaboration user.
isCollabStorage()  : bool
Returns true if the storage is a collaboration storage.
isCollabStorageById()  : bool
Returns true if the storage is a collaboration storage.
isGroupStorage()  : bool
Returns true if the storage is a group storage.

Methods

getCollabByStorage()

Returns the collaboration entity by the storage.

public getCollabByStorage(Storage $storage) : Collab|null
Parameters
$storage : Storage

Storage.

Tags
throws
ArgumentException
throws
LoaderException
throws
ObjectPropertyException
throws
SystemException
Return values
Collab|null

getCollabStorageByEntity()

Returns the collaboration storage by the entity.

public getCollabStorageByEntity(int $entityId, string $entityType) : Storage|null
Parameters
$entityId : int

Entity ID (Userfields).

$entityType : string

Entity type (Userfields).

Tags
throws
LoaderException
Return values
Storage|null

isCollabEntity()

Returns true if the entity is a collaboration entity.

public isCollabEntity(int $entityId, string $entityType) : bool
Parameters
$entityId : int

Entity ID (Userfields).

$entityType : string

Entity type (Userfields).

Return values
bool

isCollaberUserById()

Returns true if the user is a collaboration user.

public isCollaberUserById(int $userId) : bool
Parameters
$userId : int

User ID.

Tags
throws
LoaderException
throws
ObjectNotFoundException
throws
NotFoundExceptionInterface
Return values
bool

isCollabStorage()

Returns true if the storage is a collaboration storage.

public isCollabStorage(Storage $storage) : bool
Parameters
$storage : Storage
Tags
throws
ArgumentException
throws
LoaderException
throws
ObjectPropertyException
throws
SystemException
Return values
bool

isCollabStorageById()

Returns true if the storage is a collaboration storage.

public isCollabStorageById(int $storageId) : bool
Parameters
$storageId : int

Storage ID.

Tags
throws
ArgumentException
throws
LoaderException
throws
ObjectPropertyException
throws
SystemException
throws
NotImplementedException
Return values
bool

isGroupStorage()

Returns true if the storage is a group storage.

public isGroupStorage(Storage $storage) : bool
Parameters
$storage : Storage
Return values
bool

        
On this page

Search results