apollo.cannedcomments package¶

Module contents¶

Contains possible interactions with the Apollo Canned Comments Module

class apollo.cannedcomments.CannedCommentsClient(webapolloinstance, **requestArgs)¶

add_comment(comment, metadata='')¶

Add a canned comment

Parameters:	comment (str) – New canned comment metadata (str) – Optional metadata
Return type:	dict
Returns:	A dictionnary containing canned comment description

delete_comment(id_number)¶

Update a canned comment

Parameters:	id_number (int) – canned comment ID number
Return type:	dict
Returns:	an empty dictionary

get_comments()¶

Get all canned comments available in this Apollo instance

Return type:	list of dicts
Returns:	list of canned comment info dictionaries

show_comment(value)¶

Get a specific canned comment

Parameters:	value (str) – Canned comment to show
Return type:	dict
Returns:	A dictionnary containing canned comment description

update_comment(id_number, new_value, metadata=None)¶

Update a canned comment

Parameters:	id_number (int) – canned comment ID number new_value (str) – New canned comment value metadata (str) – Optional metadata
Return type:	dict
Returns:	an empty dictionary