Bitrix API

Counter

Table of Contents

Methods

getAvailableMetrics()  : array<string|int, mixed>
Returns a list of all available mertics from each connected provider
getInstance()  : self
getMemberSpaceCounters()  : array<string|int, mixed>
Returns total counters for each metric Ex.
getTotal()  : int
Returns the sum of all available mertics from each connected provider, see ProviderCollection above for the selected space $spaceId = 0 considered to be the "Common Space"
getValue()  : int
Returns the sum of mertics from each connected provider in case the metric exists in provider $spaceId = 0 considered to be the "Common Space"
updateLeftMenuCounter()  : void

Methods

getAvailableMetrics()

Returns a list of all available mertics from each connected provider

public getAvailableMetrics() : array<string|int, mixed>
Return values
array<string|int, mixed>

getInstance()

public static getInstance(int $userId) : self
Parameters
$userId : int
Return values
self

getMemberSpaceCounters()

Returns total counters for each metric Ex.

public getMemberSpaceCounters() : array<string|int, mixed>

total: 2, spaces: [{ id:1, total: 2, metrics: {countersTasksTotal: 2, countersCalendarTotal: 0, countersWorkGroupRequestTotal: 0, countersLiveFeedTotal: 0} },{....}]

Return values
array<string|int, mixed>

getTotal()

Returns the sum of all available mertics from each connected provider, see ProviderCollection above for the selected space $spaceId = 0 considered to be the "Common Space"

public getTotal([int $spaceId = 0 ]) : int
Parameters
$spaceId : int = 0
Return values
int

getValue()

Returns the sum of mertics from each connected provider in case the metric exists in provider $spaceId = 0 considered to be the "Common Space"

public getValue([int $spaceId = 0 ][, array<string|int, mixed> $metrics = [] ]) : int
Parameters
$spaceId : int = 0
$metrics : array<string|int, mixed> = []
Return values
int

updateLeftMenuCounter()

public updateLeftMenuCounter() : void

        
On this page

Search results