ProjectArea

class rtcclient.project_area.ProjectArea(url, rtc_obj, raw_data, skip_full_attributes=True)[source]

A wrapped class to perform all the operations in a Project Area

Parameters:

  • url – the project area url

  • rtc_obj – a reference to the rtcclient.client.RTCClient object

  • raw_data – the raw data ( OrderedDict ) of the request response

getAdministrator(email, returned_properties=None)[source]

Get the rtcclient.models.Administrator object by the email address

Parameters:
Returns:

the rtcclient.models.Administrator object

Return type:

rtcclient.models.Administrator

getAdministrators(returned_properties=None)[source]

Get all the rtcclient.models.Administrator objects in this project area

If no Administrators are retrieved, None is returned.

Parameters:

returned_properties – the returned properties that you want. Refer to rtcclient.client.RTCClient for more explanations

Returns:

a list that contains all rtcclient.models.Administrator objects

Return type:

list

getItemType(title, returned_properties=None)[source]

Get the rtcclient.models.ItemType object by the title

Parameters:

  • title – the title (e.g. Story/Epic/..)

  • returned_properties – the returned properties that you want. Refer to rtcclient.client.RTCClient for more explanations

Returns:

the rtcclient.models.ItemType object

Return type:

rtcclient.models.ItemType

getItemTypes(returned_properties=None)[source]

Get all the rtcclient.models.ItemType objects in this project area

If no ItemTypes are retrieved, None is returned.

Parameters:

returned_properties – the returned properties that you want. Refer to rtcclient.client.RTCClient for more explanations

Returns:

a list that contains all rtcclient.models.ItemType objects

Return type:

list

getMember(email, returned_properties=None)[source]

Get the rtcclient.models.Member object by the email address

Parameters:
Returns:

the rtcclient.models.Member object

Return type:

rtcclient.models.Member

getMembers(returned_properties=None)[source]

Get all the rtcclient.models.Member objects in this project area

If no Members are retrieved, None is returned.

Parameters:

returned_properties – the returned properties that you want. Refer to rtcclient.client.RTCClient for more explanations

Returns:

a list that contains all rtcclient.models.Member objects

Return type:

list

getRole(label)[source]

Get the rtcclient.models.Role object by the label name

Parameters:

label – the label name of the role

Returns:

the rtcclient.models.Role object

Return type:

rtcclient.models.Role

getRoles()[source]

Get all rtcclient.models.Role objects in this project area

If no Roles are retrieved, None is returned.

Returns:

a list that contains all rtcclient.models.Role objects

Return type:

list