Documentation

AnalyticsDataMsg extends Message

in package

• Application

Generated from protobuf message <code>plugnmeet.AnalyticsDataMsg</code>

Table of Contents

Properties

$event_name  : mixed

Generated from protobuf field <code>.plugnmeet.AnalyticsEvents event_name = 2;</code>

$event_type  : mixed

Generated from protobuf field <code>.plugnmeet.AnalyticsEventType event_type = 1;</code>

$event_value_integer  : mixed

if we pass value here then it will use redis INCRBY to increment value for the key

$event_value_string  : mixed

if we pass value here then it will use redis SET to set the value for the key

$extra_data  : mixed

this extra_data can be use for various purposes like, room or user metadata

$hset_value  : mixed

if we pass value here then it will use redis HSET to set hash field value for the key hash field will be unix milliseconds, so it will remain unique as always

$room_id  : mixed

Generated from protobuf field <code>string room_id = 3;</code>

$room_sid  : mixed

Generated from protobuf field <code>optional string room_sid = 8;</code>

$time  : mixed

should be unix milliseconds

$user_id  : mixed

Generated from protobuf field <code>optional string user_id = 9;</code>

$user_name  : mixed

Generated from protobuf field <code>optional string user_name = 10;</code>

Methods

__construct()  : mixed

Constructor.

clearEventValueInteger()  : mixed

clearEventValueString()  : mixed

clearExtraData()  : mixed

clearHsetValue()  : mixed

clearRoomSid()  : mixed

clearUserId()  : mixed

clearUserName()  : mixed

getEventName()  : int

Generated from protobuf field <code>.plugnmeet.AnalyticsEvents event_name = 2;</code>

getEventType()  : int

Generated from protobuf field <code>.plugnmeet.AnalyticsEventType event_type = 1;</code>

getEventValueInteger()  : int|string

if we pass value here then it will use redis INCRBY to increment value for the key

getEventValueString()  : string

if we pass value here then it will use redis SET to set the value for the key

getExtraData()  : string

this extra_data can be use for various purposes like, room or user metadata

getHsetValue()  : string

if we pass value here then it will use redis HSET to set hash field value for the key hash field will be unix milliseconds, so it will remain unique as always

getRoomId()  : string

Generated from protobuf field <code>string room_id = 3;</code>

getRoomSid()  : string

Generated from protobuf field <code>optional string room_sid = 8;</code>

getTime()  : int|string

should be unix milliseconds

getUserId()  : string

Generated from protobuf field <code>optional string user_id = 9;</code>

getUserName()  : string

Generated from protobuf field <code>optional string user_name = 10;</code>

hasEventValueInteger()  : mixed

hasEventValueString()  : mixed

hasExtraData()  : mixed

hasHsetValue()  : mixed

hasRoomSid()  : mixed

hasUserId()  : mixed

hasUserName()  : mixed

setEventName()  : $this

Generated from protobuf field <code>.plugnmeet.AnalyticsEvents event_name = 2;</code>

setEventType()  : $this

Generated from protobuf field <code>.plugnmeet.AnalyticsEventType event_type = 1;</code>

setEventValueInteger()  : $this

if we pass value here then it will use redis INCRBY to increment value for the key

setEventValueString()  : $this

if we pass value here then it will use redis SET to set the value for the key

setExtraData()  : $this

this extra_data can be use for various purposes like, room or user metadata

setHsetValue()  : $this

if we pass value here then it will use redis HSET to set hash field value for the key hash field will be unix milliseconds, so it will remain unique as always

setRoomId()  : $this

Generated from protobuf field <code>string room_id = 3;</code>

setRoomSid()  : $this

Generated from protobuf field <code>optional string room_sid = 8;</code>

setTime()  : $this

should be unix milliseconds

setUserId()  : $this

Generated from protobuf field <code>optional string user_id = 9;</code>

setUserName()  : $this

Generated from protobuf field <code>optional string user_name = 10;</code>