Class: Zulip::Client

Inherits:
Object
  • Object
show all
Includes:
EventParser, EventStreaming, Messages, QueueRegistration, StreamSubscriptions, Users
Defined in:
lib/zulip/client.rb,
lib/zulip/client/users.rb,
lib/zulip/client/messages.rb,
lib/zulip/client/event_parser.rb,
lib/zulip/client/event_streaming.rb,
lib/zulip/client/queue_registration.rb,
lib/zulip/client/stream_subscriptions.rb

Defined Under Namespace

Modules: EventParser, EventStreaming, Messages, QueueRegistration, StreamSubscriptions, Users

Constant Summary collapse

ENDPOINT = 
"https://api.zulip.com"

Constants included from QueueRegistration

QueueRegistration::EVENT_TYPES

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from EventParser

parse

Methods included from EventStreaming

#stream_events, #stream_messages, #stream_private_messages, #stream_public_messages

Methods included from QueueRegistration

#register, #registration_response

Methods included from StreamSubscriptions

#get_subscriptions, #subscribe

Methods included from Users

#get_users

Methods included from Messages

#send_message, #send_private_message

Constructor Details

#initialize {|_self| ... } ⇒ Client

Returns a new instance of Client.

Yields:

  • (_self)

Yield Parameters:

  • _self (Zulip::Client) —

    the object that the method was called on



24
25
26
 
# File 'lib/zulip/client.rb', line 24

def initialize
  yield self if block_given?
end

Instance Attribute Details

#api_key ⇒ Object

Returns the value of attribute api_key.



20
21
22
 
# File 'lib/zulip/client.rb', line 20

def api_key
  @api_key
end

#connection ⇒ Object 



28
29
30
 
# File 'lib/zulip/client.rb', line 28

def connection
  @connection ||= initialize_connection
end

#email_address ⇒ Object

Returns the value of attribute email_address.



20
21
22
 
# File 'lib/zulip/client.rb', line 20

def email_address
  @email_address
end