DashboardsApi class - jira_platform library

Constructors

DashboardsApi(ApiClient _client)

Properties

hashCode → int: The hash code for this object.
no setterinherited
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited

Methods

addGadget({required int dashboardId, required DashboardGadgetSettings body}) → Future<DashboardGadget>: Adds a gadget to a dashboard.
bulkEditDashboards({required BulkEditShareableEntityRequest body}) → Future<BulkEditShareableEntityResponse>: Bulk edit dashboards. Maximum number of dashboards to be edited at the same time is 100.
copyDashboard({required String id, required DashboardDetails body}) → Future<Dashboard>: Copies a dashboard. Any values provided in the dashboard parameter replace those in the copied dashboard.
createDashboard({required DashboardDetails body}) → Future<Dashboard>: Creates a dashboard.
deleteDashboard(String id) → Future<void>: Deletes a dashboard.
deleteDashboardItemProperty({required String dashboardId, required String itemId, required String propertyKey}) → Future<void>: Deletes a dashboard item property.
getAllAvailableDashboardGadgets() → Future<AvailableDashboardGadgetsResponse>: Gets a list of all available gadgets that can be added to all dashboards.
getAllDashboards({String? filter, int? startAt, int? maxResults}) → Future<PageOfDashboards>: Returns a list of dashboards owned by or shared with the user. The list may be filtered to include only favorite or owned dashboards.
getAllGadgets({required int dashboardId, List<String>? moduleKey, List<String>? uri, List<int>? gadgetId}) → Future<DashboardGadgetResponse>: Returns a list of dashboard gadgets on a dashboard.
getDashboard(String id) → Future<Dashboard>: Returns a dashboard.
getDashboardItemProperty({required String dashboardId, required String itemId, required String propertyKey}) → Future<EntityProperty>: Returns the key and value of a dashboard item property.
getDashboardItemPropertyKeys({required String dashboardId, required String itemId}) → Future<PropertyKeys>: Returns the keys of all properties for a dashboard item.
getDashboardsPaginated({String? dashboardName, String? accountId, String? owner, String? groupname, String? groupId, int? projectId, String? orderBy, int? startAt, int? maxResults, String? status, String? expand}) → Future<PageBeanDashboard>: Returns a paginated list of dashboards. This operation is similar to Get dashboards except that the results can be refined to include dashboards that have specific attributes. For example, dashboards with a particular name. When multiple attributes are specified only filters matching all attributes are returned.
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
removeGadget({required int dashboardId, required int gadgetId}) → Future: Removes a dashboard gadget from a dashboard.
setDashboardItemProperty({required String dashboardId, required String itemId, required String propertyKey, required dynamic body}) → Future: Sets the value of a dashboard item property. Use this resource in apps to store custom data against a dashboard item.
toString() → String: A string representation of this object.
inherited
updateDashboard({required String id, required DashboardDetails body}) → Future<Dashboard>: Updates a dashboard, replacing all the dashboard details with those provided.
updateGadget({required int dashboardId, required int gadgetId, required DashboardGadgetUpdateRequest body}) → Future: Changes the title, position, and color of the gadget on a dashboard.

Operators

operator ==(Object other) → bool: The equality operator.
inherited