Class EtherpadLite::Pad
In: lib/etherpad-lite/models/pad.rb
Parent: Object

An Etherpad Lite Pad

This class allows you to interact with pads stored in an Etherpad Lite server. The README has some basic examples.

Note that some functions are restricted to Group pads.

Methods

author_ids   authors   changeset   chat_messages   chat_size   create   degroupify_pad_id   delete   diff   group   group_id   html   html=   last_edited   message   name   new   password=   password?   private=   private?   public=   public?   read_only_id   revision_numbers   revisions   text   text=   user_count   users   users_count  

Attributes

id  [R]  The pad id
instance  [R]  The EtherpadLite::Instance object
rev  [R]  An optional pad revision number

Public Class methods

create(instance, id, options={})

Creates and returns a new Pad.

Options:

text => ‘initial Pad text‘

groupID => group id of Group new Pad should belong to

degroupify_pad_id(pad_id)

Remove the group id portion of a Group Pad‘s id

new(instance, id, options={})

Instantiate a Pad. It is presumed to already exist (via Pad.create).

Options:

groupID => a group id

group => an EtherpadLite::Group object

rev => a pad revision number

Public Instance methods

author_ids()

Returns an array of ids of authors who‘ve edited this pad

authors()

Returns an array of Authors who‘ve edited this pad

changeset(rev)

Returns the changeset for the given revision

chat_size()

Returns the number of chat messages

delete()

Deletes the Pad

diff(start_rev, end_rev=nil)

Returns a Diff. If end_rev is not specified, the latest revision will be used

group()

Returns this Pad‘s group, if any

group_id()

Returns the group_id of this Pad, if any

html(options={})

Returns the Pad‘s text as HTML. Unless you specified a :rev when instantiating the Pad, or specify one here, this will return the latest revision.

Options:

rev => revision_number

html=(html)

Writes HTML to the Pad. There is no ‘save’ method; it is written immediately.

last_edited()

Returns the time the pad was last edited as a Unix timestamp

message(msg)

Sends a custom message of type msg to the pad.

name()

Returns the name of the Pad. For a normal pad, this is the same as it‘s id. But for a Group Pad, this strips away the group id part of the pad id.

password=(new_password)

Sets the Pad‘s password. This only applies to Pads belonging to a Group.

password?()

Returns true if this Pad has a password, false if not. This only applies to Pads belonging to a Group.

private=(status)

Set the pad‘s private status to true or false (opposite of public=) This only applies to Pads belonging to a Group.

private?()

Returns true if this is a private Pad (opposite of public?) This only applies to Pads belonging to a Group.

public=(status)

Set the pad‘s public status to true or false (opposite of private=) This only applies to Pads belonging to a Group.

public?()

Returns true if this is a public Pad (opposite of private?). This only applies to Pads belonging to a Group.

read_only_id()

Returns the Pad‘s read-only id. This is cached.

revision_numbers()

Returns an Array of all this Pad‘s revision numbers

revisions()

Returns an array of Pad objects, each with an increasing revision of the text.

text(options={})

Returns the Pad‘s text. Unless you specified a :rev when instantiating the Pad, or specify one here, this will return the latest revision.

Options:

rev => revision_number

text=(txt)

Writes txt to the Pad. There is no ‘save’ method; it is written immediately.

user_count()

Returns the number of users currently editing a pad

users()

Returns an array of users hashes, representing users currently using the pad

users_count()

Alias for user_count

[Validate]