Note

This object represents pump.io’s notes, these are used to post text to a person‘s inbox.

Note

The pump variable is an instantiated PyPump class e.g. pump = PyPump(“<webfinger>”, client_name=”<name>”, etc...)

class Note

This represents a note, short-form text message, these appear in the stream

content

This is the content of the Note:

>>> my_note = pump.Note("I'm posting on pump.io")
>>> my_note.content
"I'm posting on pump.io"
actor

This is who posted the Note (Person object):

>>> my_note = pump.Note("I'm posting on pump.io")
>>> my_note.actor
<Person: Tsyesika@pump.megworld.co.uk>
updated

This is when it was last updated (posted, commented, etc.) this is a datetime.datetime object

>>> my_note.updated
datetime.datetime(2013, 6, 15, 12, 31, 22, 134180)
published

This is when the Note was first published, this is a datetime.datetime object

>>> my_note.published
datetime.datetime(2013, 6, 15, 12, 31, 22, 134180)
to

This is a list of person objects, who the Note was to:

>>> my_note.to
[<Person: Tsyesika@pump.megworld.co.uk>, <Person: Tuteo@another.server.co.uk>]
cc

This is a list of person objects, who was carbon copied into the Note:

>>> my_note.cc
[<Person: someone@microca.st>]
comment(comment)

This takes in a Comment object, this will send the comment to the remote server.

delete()

This will delete the object.

Example

This shows making a new post:

>>> my_note = pump.Note("This is a new note!") # pump is instance of PyPump

You want to comment?:

>>> my_comment = pump.Comment("I'm commenting on my note")
>>> my_note.comment(my_comment)

You can like the note:

>>> my_comment.like()

Oh wait? you didn’t want to...:

>>> my_comment.unlike()

Oh you didn’t want to post the note?:

>>> my_comment.delete()
>>> my_comment = None # we don't want to accidently try and use a deleted comment

Warning

Using a comment object after deletion will raise a DoesNotExist exception