ScreensApi class
Jira Cloud platform REST API documentation
Constructors
- ScreensApi(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
-
addFieldToDefaultScreen(
String fieldId) → Future - Adds a field to the default tab of the default screen.
-
createScreen(
{required ScreenDetails body}) → Future< Screen> - Creates a screen with a default field tab.
-
deleteScreen(
int screenId) → Future< void> - Deletes a screen. A screen cannot be deleted if it is used in a screen scheme, workflow, or workflow draft.
-
getAvailableScreenFields(
int screenId) → Future< List< ScreenableField> > - Returns the fields that can be added to a tab on a screen.
-
getScreens(
{int? startAt, int? maxResults, List< int> ? id, String? queryString, List<String> ? scope, String? orderBy}) → Future<PageBeanScreen> - Returns a paginated list of all screens or those specified by one or more screen IDs.
-
getScreensForField(
{required String fieldId, int? startAt, int? maxResults, String? expand}) → Future< PageBeanScreenWithTab> - Returns a paginated list of the screens a field is used in.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
-
updateScreen(
{required int screenId, required UpdateScreenDetails body}) → Future< Screen> - Updates a screen. Only screens used in classic projects can be updated.
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited