Ulysses¶
- class apps.Ulysses¶
Actions for Ulysses.
- attach_image(id=None, image=None, format=None, filename=None) str¶
Creates a new image attachment on a sheet.
- attach_keywords(id=None, keywords=None) str¶
Adds one or more keywords to a sheet.
- attach_note(id=None, text=None, format=None) str¶
Creates a new note attachment on a sheet.
- copy(id=None, targetGroup=None, index=None) str¶
Copies an item (sheet or group) to a target group and/or to a new position.
- get_item_group(id=None, recursive=None) str¶
Retrieves information about a group. Requires authorization.
- get_item_sheet(id=None) str¶
Retrieves information about a sheet. Requires authorization.
- get_root_items(recursive=None) str¶
Retrieves information about the root sections. Can be used to get a full listing of the entire Ulysses library. Requires authorization.
- insert(id=None, text=None, format=None, position=None, newline=None) str¶
Inserts or appends text to a sheet.
- move(id=None, targetGroup=None, index=None) str¶
Moves an item (sheet or group) to a target group and/or to a new position. Requires authorization.
- new_group(name=None, parent=None, index=None) str¶
Creates a new group.
- new_sheet(text=None, group=None, format=None, index=None) str¶
Creates a new sheet.
- open_all() str¶
Opens the special “All” group
- open_favorites() str¶
Opens the special “Favorites” group
- open_recent() str¶
Opens the special “Last 7 days” group
- read_sheet(id=None, text=None, Open=None) str¶
Retrieves the contents (text, notes, keywords) of a sheet. Requires authorization.
- remove_keywords(id=None, keywords=None) str¶
Removes one or more keywords from a sheet. Requires authorization.
- remove_note(id=None, index=None) str¶
Removes a note attachment from a sheet. Requires authorization.
- set_group_title(group=None, title=None) str¶
Changes the title of a group. Requires authorization.
- set_sheet_title(sheet=None, type=None, title=None) str¶
Changes the first paragraph of a sheet. Requires authorization. If the sheet has a first paragraph with the requested type, the paragraph contents will be changed (a heading replaces any existing heading). Otherwise, a new paragraph with the requested type and contents will be inserted at the beginning of the sheet.
- trash(id=None) str¶
Moves an item (sheet or group) to the trash. Requires authorization.
- update_note(id=None, text=None, format=None, index=None) str¶
Changes an existing note attachment on a sheet. Requires authorization.