Class EtherpadLite::Session
In: lib/etherpad-lite/models/session.rb
Parent: Object

An Etherpad Lite Session between a Group and an Author. See those classes for examples of how to create a session.

Sessions are useful for embedding an Etherpad Lite Pad into a external application. For public pads, sessions are not necessary. However Group pads require a Session to access to the pad via the Web UI.

Generally, you will create the session server side, then pass its id to the embedded pad using a cookie. See the README for an example in a Rails app.

Methods

author   author_id   create   delete   expired?   group   group_id   new   valid?   valid_until  

Attributes

id  [R]  The session id
instance  [R]  The EtherpadLite::Instance object

Public Class methods

create(instance, group_id, author_id, length_in_min)

Creates a new Session between a Group and an Author. The session will expire after length_in_min.

new(instance, id, info=nil)

Instantiates a Session object (presumed to already exist)

Public Instance methods

author()

Returns the Session‘s author

author_id()

Returns the Session‘s author id

delete()

Deletes the Session

expired?()

Returns true if the session is expired

group()

Returns the Session‘s group

group_id()

Returns the Session‘s group id

valid?()

Returns true if the session is not expired

valid_until()

Returns the Session‘s expiration date is a Unix timestamp in seconds

[Validate]