Class: EtherpadLite::Instance

Attributes

client [R] Stores the EtherpadLite::Client object used to power this Instance

Public Class methods

new(url_or_port, api_key_or_file, api_version=nil)

Instantiate a new Etherpad Lite Instance. You may pass a full url or just a port number. The api key may be a string or a File object.

Public Instance methods

author(mapper, options={})

Returns, creating if necessary, a Author mapped to your foreign system‘s author

Options:

name => the Author‘s name

create_author(options={})

Creates a new Author. Optionally, you may pass the :mapper option your third party system‘s author id. This will allow you to find the Author again later using the same identifier as your foreign system.

Options:

mapper => your foreign author id

 name => the Author's name

create_group(options={})

Creates a new Group. Optionally, you may pass the :mapper option your third party system‘s group id. This will allow you to find your Group again later using the same identifier as your foreign system.

Options:

mapper => your foreign group id

get_author(id)

Returns an Author with the given id (it is presumed to already exist).

get_group(id)

Returns a Group with the given id (it is presumed to already exist).

get_session(session_id)

Returns a Session (presumed to already exist).

group(mapper)

Returns, creating if necessary, a Group mapped to your foreign system‘s group

group_ids()

Returns an array of all group IDs