IssueCustomFieldContextsApi class - jira_platform library

Constructors

IssueCustomFieldContextsApi(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

addIssueTypesToContext({required String fieldId, required int contextId, required IssueTypeIds body}) → Future: Adds issue types to a custom field context, appending the issue types to the issue types list.
assignProjectsToCustomFieldContext({required String fieldId, required int contextId, required ProjectIds body}) → Future: Assigns a custom field context to projects.
createCustomFieldContext({required String fieldId, required CreateCustomFieldContext body}) → Future<CreateCustomFieldContext>: Creates a custom field context.
deleteCustomFieldContext({required String fieldId, required int contextId}) → Future: Deletes a custom field context.
getContextsForField({required String fieldId, bool? isAnyIssueType, bool? isGlobalContext, List<int>? contextId, int? startAt, int? maxResults}) → Future<PageBeanCustomFieldContext>: Returns a paginated list of contexts for a custom field. Contexts can be returned as follows:
getCustomFieldContextsForProjectsAndIssueTypes({required String fieldId, int? startAt, int? maxResults, required ProjectIssueTypeMappings body}) → Future<PageBeanContextForProjectAndIssueType>: Returns a paginated list of project and issue type mappings and, for each mapping, the ID of a custom field context that applies to the project and issue type.
getDefaultValues({required String fieldId, List<int>? contextId, int? startAt, int? maxResults}) → Future<PageBeanCustomFieldContextDefaultValue>: Returns a paginated list of defaults for a custom field. The results can be filtered by contextId, otherwise all values are returned. If no defaults are set for a context, nothing is returned. The returned object depends on type of the custom field:
getIssueTypeMappingsForContexts({required String fieldId, List<int>? contextId, int? startAt, int? maxResults}) → Future<PageBeanIssueTypeToContextMapping>: Returns a paginated list of context to issue type mappings for a custom field. Mappings are returned for all contexts or a list of contexts. Mappings are ordered first by context ID and then by issue type ID.
getProjectContextMapping({required String fieldId, List<int>? contextId, int? startAt, int? maxResults}) → Future<PageBeanCustomFieldContextProjectMapping>: Returns a paginated list of context to project mappings for a custom field. The result can be filtered by contextId. Otherwise, all mappings are returned. Invalid IDs are ignored.
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
removeCustomFieldContextFromProjects({required String fieldId, required int contextId, required ProjectIds body}) → Future: Removes a custom field context from projects.
removeIssueTypesFromContext({required String fieldId, required int contextId, required IssueTypeIds body}) → Future: Removes issue types from a custom field context.
setDefaultValues({required String fieldId, required CustomFieldContextDefaultValueUpdate body}) → Future: Sets default for contexts of a custom field. Default are defined using these objects:
toString() → String: A string representation of this object.
inherited
updateCustomFieldContext({required String fieldId, required int contextId, required CustomFieldContextUpdateDetails body}) → Future: Updates a custom field context.

Operators

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