Module: Pubnub::Client::GettersSetters

Extended by:
Gem::Deprecate
Included in:
Pubnub::Client
Defined in:
lib/pubnub/client/getters_setters.rb

Overview

Module that holds some getters and setters

Instance Method Summary collapse

Instance Method Details

#change_user_id(user_id) ⇒ Object Also known as: session_user_id=, user_id=, set_user_id=

Parameters:

user_id
New user_id to be set. Note that this will override uuid value

Returns:

New user_id.

Functionality:

Can't change user_id while subscribed. You have to leave every subscribed channel.



49
50
51
52
53
54
55
 
# File 'lib/pubnub/client/getters_setters.rb', line 49

def change_user_id(user_id)
  Pubnub.logger.debug('Pubnub::Client') { 'Changing user_id' }
  raise('Cannot change user_id while subscribed.') if subscribed?
  Validator::Client.validate_user_id user_id

  @env[:user_id] = user_id
end

#change_uuid(uuid) ⇒ Object Also known as: session_uuid=, uuid=, set_uuid=

Parameters:

uuid
New uuid to be set. Note that this will override user_id value

Returns:

New uuid.

Functionality:

Can't change uuid while subscribed. You have to leave every subscribed channel.



30
31
32
 
# File 'lib/pubnub/client/getters_setters.rb', line 30

def change_uuid(uuid)
  change_user_id(uuid)
end

#current_heartbeat ⇒ Object

:nocov:



145
146
147
 
# File 'lib/pubnub/client/getters_setters.rb', line 145

def current_heartbeat
  @env[:heartbeat].to_i
end

#current_origin ⇒ Object Also known as: origin

Returns:

Current origin.



67
68
69
 
# File 'lib/pubnub/client/getters_setters.rb', line 67

def current_origin
  @env[:origin]
end

#events ⇒ Object

Returns:

Array of all current events. :nocov:



139
140
141
 
# File 'lib/pubnub/client/getters_setters.rb', line 139

def events
  @env[:events]
end

#heartbeat=(value) ⇒ Object 



149
150
151
 
# File 'lib/pubnub/client/getters_setters.rb', line 149

def heartbeat=(value)
  @env[:heartbeat] = value
end

#origin=(origin) ⇒ Object

Returns:

Origin that was set.



76
77
78
 
# File 'lib/pubnub/client/getters_setters.rb', line 76

def origin=(origin)
  @env[:origin] = origin
end

#region_code ⇒ Object

Retruns:

Current region or default '0'



90
91
92
 
# File 'lib/pubnub/client/getters_setters.rb', line 90

def region_code
  @env[:region_code] || 0
end

#region_code=(region) ⇒ Object

Parameters:

region
New region.

Returns:

New region.



103
104
105
 
# File 'lib/pubnub/client/getters_setters.rb', line 103

def region_code=(region)
  @env[:region_code] = region
end

#sdk_version ⇒ Object 



12
13
14
 
# File 'lib/pubnub/client/getters_setters.rb', line 12

def sdk_version
  "PubNub-Ruby/#{Pubnub::VERSION}"
end

#subscribe_filter ⇒ Object 



158
159
160
 
# File 'lib/pubnub/client/getters_setters.rb', line 158

def subscribe_filter
  @env[:subscribe_filter]
end

#subscribe_filter=(filter_exp) ⇒ Object 



153
154
155
156
 
# File 'lib/pubnub/client/getters_setters.rb', line 153

def subscribe_filter=(filter_exp)
  @subscriber.reset if subscribed?
  @env[:subscribe_filter] = filter_exp
end

#timetoken ⇒ Object

Returns:

Current client timetoken



83
84
85
 
# File 'lib/pubnub/client/getters_setters.rb', line 83

def timetoken
  @env[:timetoken]
end

#timetoken=(timetoken) ⇒ Object

Parameters:

timetoken
New timetoken.

Returns:

New timetoken.



116
117
118
 
# File 'lib/pubnub/client/getters_setters.rb', line 116

def timetoken=(timetoken)
  @env[:timetoken] = timetoken
end

#user_id ⇒ Object

Returns:

Current user_id.



131
132
133
 
# File 'lib/pubnub/client/getters_setters.rb', line 131

def user_id
  @env[:user_id]
end

#uuid ⇒ Object

Returns:

Current uuid.



123
124
125
 
# File 'lib/pubnub/client/getters_setters.rb', line 123

def uuid
  user_id
end