iframe-proxy | Sunbelt Computer Software

History

174 lines (148 loc) · 5.05 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

"""note Fluent API Helper."""

# @file note.py

# @brief note Fluent API Helper.

# @section description Description

# This module contains helper methods for calling note.* Notecard API commands.

# This module is optional and not required for use with the Notecard.

import notecard

from .validators import validate_card_object

@validate_card_object

def add(card, file=None, body=None, payload=None, sync=None):

"""Add a Note to a Notefile.

Args:

card (Notecard): The current Notecard object.

file (string): The name of the file.

body (JSON object): A developer-defined tracker ID.

payload (string): An optional base64-encoded string.

sync (bool): Perform an immediate sync after adding.

Returns:

string: The result of the Notecard request.

"""

req = {"req": "note.add"}

if file:

req["file"] = file

if body:

req["body"] = body

if payload:

req["payload"] = payload

if sync is not None:

req["sync"] = sync

return card.Transaction(req)

@validate_card_object

def changes(card, file=None, tracker=None, maximum=None,

start=None, stop=None, deleted=None, delete=None):

"""Incrementally retrieve changes within a Notefile.

Args:

card (Notecard): The current Notecard object.

file (string): The name of the file.

tracker (string): A developer-defined tracker ID.

maximum (int): Maximum number of notes to return.

start (bool): Should tracker be reset to the beginning

before a get.

stop (bool): Should tracker be deleted after get.

deleted (bool): Should deleted notes be returned.

delete (bool): Should notes in a response be auto-deleted.

Returns:

string: The result of the Notecard request.

"""

req = {"req": "note.changes"}

if file:

req["file"] = file

if tracker:

req["tracker"] = tracker

if maximum:

req["max"] = maximum

if start is not None:

req["start"] = start

if stop is not None:

req["stop"] = stop

if deleted is not None:

req["deleted"] = deleted

if delete is not None:

req["delete"] = delete

return card.Transaction(req)

@validate_card_object

def get(card, file="data.qi", note_id=None, delete=None, deleted=None):

"""Retrieve a note from an inbound or DB Notefile.

Args:

card (Notecard): The current Notecard object.

file (string): The inbound or DB notefile to retrieve a

Notefile from.

note_id (string): (DB files only) The ID of the note to retrieve.

delete (bool): Whether to delete the note after retrieval.

deleted (bool): Whether to allow retrieval of a deleted note.

Returns:

string: The result of the Notecard request.

"""

req = {"req": "note.get"}

req["file"] = file

if note_id:

req["note"] = note_id

if delete is not None:

req["delete"] = delete

if deleted is not None:

req["deleted"] = deleted

return card.Transaction(req)

@validate_card_object

def delete(card, file=None, note_id=None):

"""Delete a DB note in a Notefile by its ID.

Args:

card (Notecard): The current Notecard object.

file (string): The file name of the DB notefile.

note_id (string): The id of the note to delete.

Returns:

string: The result of the Notecard request.

"""

req = {"req": "note.delete"}

if file:

req["file"] = file

if note_id:

req["note"] = note_id

return card.Transaction(req)

@validate_card_object

def update(card, file=None, note_id=None, body=None, payload=None):

"""Update a note in a DB Notefile by ID.

Args:

card (Notecard): The current Notecard object.

file (string): The file name of the DB notefile.

note_id (string): The id of the note to update.

body (JSON): The JSON object to add to the note.

payload (string): The base64-encoded JSON payload to

add to the note.

Returns:

string: The result of the Notecard request.

"""

req = {"req": "note.update"}

if file:

req["file"] = file

if note_id:

req["note"] = note_id

if body:

req["body"] = body

if payload:

req["payload"] = payload

return card.Transaction(req)

@validate_card_object

def template(card, file=None, body=None, length=None):

"""Create a template for new Notes in a Notefile.

Args:

card (Notecard): The current Notecard object.

file (string): The file name of the notefile.

body (JSON): A sample JSON body that specifies field names and

values as "hints" for the data type.

length (int): If provided, the maximum length of a payload that

can be sent in Notes for the template Notefile.

Returns:

string: The result of the Notecard request.

"""

req = {"req": "note.template"}

if file:

req["file"] = file

if body:

req["body"] = body

if length:

req["length"] = length

return card.Transaction(req)

Sunbelt Computer Software

PL/B Language Development and Support

Navigation Menu

Sunbelt Computer Software

PL/B Language Development and Support

FilesExpand file tree

note.py

Latest commit

History

note.py

File metadata and controls