jira.Comment

class documentation

class Comment(Resource): (source)

An issue comment.

Method	`__init__`	Initializes a generic resource.
Method	`update`	Update a comment.
Instance Variable	`raw`	Undocumented

Inherited from Resource:

Method	`__eq__`	Default equality test.
Method	`__getattr__`	Allow access of attributes via names.
Method	`__getstate__`	Pickling the resource.
Method	`__hash__`	Hash calculation.
Method	`__repr__`	Identify the class and include any and all relevant values.
Method	`__setstate__`	Unpickling of the resource.
Method	`__str__`	Return the first value we find that is likely to be human-readable.
Method	`delete`	Delete this resource from the server, passing the specified query parameters.
Method	`find`	Finds a resource based on the input parameters.
Constant	`JIRA_BASE_URL`	Undocumented
Method	`_default_headers`	Undocumented
Method	`_find_by_url`	Finds a resource on the specified url.
Method	`_get_url`	Gets the url for the specified path.
Method	`_load`	Load a resource.
Method	`_parse_raw`	Parse a raw dictionary to create a resource.
Constant	`_HASH_IDS`	Undocumented
Constant	`_READABLE_IDS`	Undocumented
Instance Variable	`_base_url`	Undocumented
Instance Variable	`_options`	Undocumented
Instance Variable	`_resource`	Undocumented
Instance Variable	`_session`	Undocumented

def __init__(self, options: Dict[str, str], session: ResilientSession, raw: Dict[str, Any] = None): (source) ¶

overrides jira.resources.Resource.__init__

Initializes a generic resource. Args: resource (str): The name of the resource. options (Dict[str,str]): Options for the new resource session (ResilientSession): Session used for the resource. base_url (Optional[str]): The Base Jira url.

def update(self, fields: Optional[Dict[str, Any]] = None, async_: Optional[bool] = None, jira: JIRA = None, body: str = '', visibility: Optional[Dict[str, str]] = None, is_internal: bool = False, notify: bool = True): (source) ¶

overrides jira.resources.Resource.update

Update a comment. Keyword arguments are marshalled into a dict before being sent. Args: fields (Optional[Dict[str, Any]]): DEPRECATED => a comment doesn't have fields async_ (Optional[bool]): True to add the request to the queue, so it can be executed later using async_run() (Default: ``None``)) jira (jira.client.JIRA): Instance of Jira Client visibility (Optional[Dict[str, str]]): a dict containing two entries: "type" and "value". "type" is 'role' (or 'group' if the Jira server has configured comment visibility for groups) "value" is the name of the role (or group) to which viewing of this comment will be restricted. body (str): New text of the comment is_internal (bool): True to mark the comment as 'Internal' in Jira Service Desk (Default: ``False``) notify (bool): True to notify watchers about the update, sets parameter notifyUsers. (Default: ``True``). Admin or project admin permissions are required to disable the notification.

raw: Dict[str, Any] = (source) ¶

overrides jira.resources.Resource.raw

Undocumented