Class Author
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected StringThe account ID of the user, which uniquely identifies the user across all Atlassian products.protected Stringprotected Stringprotected BooleanThis is deprecated.protected BooleanThis is deprecated.protected BooleanWhether the user is a guest userprotected Objectprotected StringThe public name or nickname of the user.protected Stringprotected StringThis property is no longer available and will be removed from the documentation soon.protected StringThis property is no longer available and will be removed from the documentation soon. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedAuthor()Protected no-args constructor for use by serialization frameworks.Author(String type, String displayName, Object operations, String username, String userKey, String accountId, String accountType, Boolean externalCollaborator, Boolean isExternalCollaborator, Boolean isGuest, String publicName) Constructs a validated instance ofAuthor.Constructs a validated instance ofAuthor. -
Method Summary
Modifier and TypeMethodDescriptionFluent getter for accountId.Fluent setter for accountId.Fluent getter for accountType.accountType(String accountType) Fluent setter for accountType.Fluent getter for displayName.displayName(String displayName) Fluent setter for displayName.booleanFluent getter for externalCollaborator.externalCollaborator(Boolean externalCollaborator) Fluent setter for externalCollaborator.Gets the value of accountId.Gets the value of accountType.Gets the value of displayName.Gets the value of externalCollaborator.Gets the value of isExternalCollaborator.Gets the value of isGuest.Gets the value of operations.Gets the value of publicName.getType()Gets the value of type.Gets the value of userKey.Gets the value of username.inthashCode()Fluent getter for isExternalCollaborator.isExternalCollaborator(Boolean isExternalCollaborator) Fluent setter for isExternalCollaborator.isGuest()Fluent getter for isGuest.Fluent setter for isGuest.Fluent getter for operations.operations(Object operations) Fluent setter for operations.Fluent getter for publicName.publicName(String publicName) Fluent setter for publicName.voidsetAccountId(String accountId) Sets the value of accountId.voidsetAccountType(String accountType) Sets the value of accountType.voidsetDisplayName(String displayName) Sets the value of displayName.voidsetExternalCollaborator(Boolean externalCollaborator) Sets the value of externalCollaborator.voidsetIsExternalCollaborator(Boolean isExternalCollaborator) Sets the value of isExternalCollaborator.voidsetIsGuest(Boolean isGuest) Sets the value of isGuest.voidsetOperations(Object operations) Sets the value of operations.voidsetPublicName(String publicName) Sets the value of publicName.voidSets the value of type.voidsetUserKey(String userKey) Sets the value of userKey.voidsetUsername(String username) Sets the value of username.toString()type()Fluent getter for type.Fluent setter for type.userKey()Fluent getter for userKey.Fluent setter for userKey.username()Fluent getter for username.Fluent setter for username.
-
Field Details
-
type
-
displayName
-
operations
-
username
This property is no longer available and will be removed from the documentation soon. Use `accountId` instead. See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details. -
userKey
This property is no longer available and will be removed from the documentation soon. Use `accountId` instead. See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details. -
accountId
The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`. -
accountType
-
externalCollaborator
This is deprecated. Use `isGuest` instead. -
isExternalCollaborator
This is deprecated. Use `isGuest` instead. Whether the user is an external collaborator user -
isGuest
Whether the user is a guest user -
publicName
The public name or nickname of the user. Will always contain a value.
-
-
Constructor Details
-
Author
-
Author
@Internal protected Author()Protected no-args constructor for use by serialization frameworks. -
Author
@Internal public Author(String type, String displayName, Object operations, String username, String userKey, String accountId, String accountType, Boolean externalCollaborator, Boolean isExternalCollaborator, Boolean isGuest, String publicName) Constructs a validated instance ofAuthor.NOTE: This constructor is not considered stable and may change if the model is updated. Consider using
Author(Consumer)instead.- Parameters:
type- typedisplayName- displayNameoperations- operationsusername- This property is no longer available and will be removed from the documentation soon. Use `accountId` instead. See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.userKey- This property is no longer available and will be removed from the documentation soon. Use `accountId` instead. See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.accountId- The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`.accountType- accountTypeexternalCollaborator- This is deprecated. Use `isGuest` instead.isExternalCollaborator- This is deprecated. Use `isGuest` instead. Whether the user is an external collaborator userisGuest- Whether the user is a guest userpublicName- The public name or nickname of the user. Will always contain a value.
-
-
Method Details
-
type
-
type
-
getType
-
setType
-
displayName
-
displayName
-
getDisplayName
-
setDisplayName
Sets the value of displayName.- Parameters:
displayName- displayName
-
operations
-
operations
-
getOperations
-
setOperations
Sets the value of operations.- Parameters:
operations- operations
-
username
Fluent getter for username.This property is no longer available and will be removed from the documentation soon. Use `accountId` instead. See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.
- Returns:
- username
-
username
Fluent setter for username.This property is no longer available and will be removed from the documentation soon. Use `accountId` instead. See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.
- Parameters:
username- username- Returns:
- this
-
getUsername
Gets the value of username.This property is no longer available and will be removed from the documentation soon. Use `accountId` instead. See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.
- Returns:
- username
-
setUsername
Sets the value of username.This property is no longer available and will be removed from the documentation soon. Use `accountId` instead. See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.
- Parameters:
username- username
-
userKey
Fluent getter for userKey.This property is no longer available and will be removed from the documentation soon. Use `accountId` instead. See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.
- Returns:
- userKey
-
userKey
Fluent setter for userKey.This property is no longer available and will be removed from the documentation soon. Use `accountId` instead. See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.
- Parameters:
userKey- userKey- Returns:
- this
-
getUserKey
Gets the value of userKey.This property is no longer available and will be removed from the documentation soon. Use `accountId` instead. See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.
- Returns:
- userKey
-
setUserKey
Sets the value of userKey.This property is no longer available and will be removed from the documentation soon. Use `accountId` instead. See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.
- Parameters:
userKey- userKey
-
accountId
Fluent getter for accountId.The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`.
- Returns:
- accountId
-
accountId
-
getAccountId
Gets the value of accountId.The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`.
- Returns:
- accountId
-
setAccountId
Sets the value of accountId.The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`.
- Parameters:
accountId- accountId
-
accountType
-
accountType
-
getAccountType
-
setAccountType
Sets the value of accountType.- Parameters:
accountType- accountType
-
externalCollaborator
Fluent getter for externalCollaborator.This is deprecated. Use `isGuest` instead.
- Returns:
- externalCollaborator
-
externalCollaborator
-
getExternalCollaborator
Gets the value of externalCollaborator.This is deprecated. Use `isGuest` instead.
- Returns:
- externalCollaborator
-
setExternalCollaborator
Sets the value of externalCollaborator.This is deprecated. Use `isGuest` instead.
- Parameters:
externalCollaborator- externalCollaborator
-
isExternalCollaborator
Fluent getter for isExternalCollaborator.This is deprecated. Use `isGuest` instead. Whether the user is an external collaborator user
- Returns:
- isExternalCollaborator
-
isExternalCollaborator
-
getIsExternalCollaborator
Gets the value of isExternalCollaborator.This is deprecated. Use `isGuest` instead. Whether the user is an external collaborator user
- Returns:
- isExternalCollaborator
-
setIsExternalCollaborator
Sets the value of isExternalCollaborator.This is deprecated. Use `isGuest` instead. Whether the user is an external collaborator user
- Parameters:
isExternalCollaborator- isExternalCollaborator
-
isGuest
Fluent getter for isGuest.Whether the user is a guest user
- Returns:
- isGuest
-
isGuest
-
getIsGuest
Gets the value of isGuest.Whether the user is a guest user
- Returns:
- isGuest
-
setIsGuest
Sets the value of isGuest.Whether the user is a guest user
- Parameters:
isGuest- isGuest
-
publicName
Fluent getter for publicName.The public name or nickname of the user. Will always contain a value.
- Returns:
- publicName
-
publicName
-
getPublicName
Gets the value of publicName.The public name or nickname of the user. Will always contain a value.
- Returns:
- publicName
-
setPublicName
Sets the value of publicName.The public name or nickname of the user. Will always contain a value.
- Parameters:
publicName- publicName
-
equals
-
hashCode
-
toString
-