User Model

The User class represents a user within the community, capturing various attributes and details. Below are the details of the User model:

Properties

Variable	Type	Description	Optional
id	int	The unique identifier of the user.
name	String	The name of the user.
imageUrl	String	The URL of the user's profile image.
isGuest	bool	Indicates whether the user is a guest.
userUniqueId	String	The unique identifier of the user.	✔
organisationName	String	The name of the user's organization.	✔
sdkClientInfo	SDKClientInfo	Information about the SDK client associated with the user.	✔
updatedAt	int	The timestamp when the user was last updated.	✔
isOwner	bool	Indicates whether the user is an owner.	✔
customTitle	String	Custom title assigned to the user.	✔
memberSince	String	The date when the user became a member of the community.	✔
route	String	The route associated with the user.	✔
state	int	The state of the user.	✔
communityId	int	The unique identifier of the community to which the user belongs.	✔
createdAt	int	The timestamp when the user was created.	✔
isDeleted	bool	Indicates whether the user is deleted.	✔

UserTag Model

The UserTag class represents user tags, providing information about a user in a specific context. Below are the details of the UserTag model:

Properties

Variable	Type	Description	Optional
name	String	The name associated with the user tag.	✔
imageUrl	String	The URL of the image associated with the user.	✔
customTitle	String	The custom title associated with the user tag.	✔
id	int	The unique identifier of the user.	✔
isGuest	bool	Indicates whether the user is a guest.	✔
userUniqueId	String	The unique identifier of the user.	✔
sdkClientInfo	SDKClientInfo	SDK client information associated with the user.	✔

SDKClientInfo

The SDKClientInfo class represents information about the SDK client, providing details about the version, build number, and user association. Below are the details of the SDKClientInfo model:

Properties

Variable	Type	Description	Optional
community	int	The community identifier for the SDK.
user	int	The user identifier for the SDK.
userUniqueId	String	The unique identifier of the user.	✔

MemberRight

The MemberRight class represents the rights assigned to a community member, indicating their privileges and access levels. Below are the details of the MemberRight model:

Properties

Variable	Type	Description	Optional
id	int	The unique identifier of the member right.
isSelected	bool	Indicates whether the member right is selected.
state	int	The state of the member right.
title	String	The title or name of the member right.

MemberAction

The MemberAction class represents an action that a member can take, capturing the title and route of the action. Below are the details of the MemberAction model:

Properties

Variable	Type	Description	Optional
title	String	The title or name of the member action.
route	String	The route or path associated with the member action.

QuestionAnswer

The QuestionAnswer class represents a combination of a question and its corresponding answer. This model is useful for handling scenarios where both question and answer details are needed together. Below are the details of the QuestionAnswer model:

Properties

Variable	Type	Description	Optional
answer	Answer	The answer associated with the question.
question	Question	The question for which the answer is provided.

Question

The Question class represents a question within a community or a system, capturing various attributes related to the question. Below are the details of the Question model:

Properties

Variable	Type	Description	Optional
id	String	The unique identifier of the question.	✔
questionTitle	String	The title or text of the question.
state	int	The state of the question.
value	String	The value associated with the question.	✔
optional	bool	Indicates whether the question is optional.
helpText	String	Additional help text or information for the question.	✔
field	bool	Indicates whether the question is a field.	✔
isCompulsory	bool	Indicates whether the question is compulsory.	✔
isHidden	bool	Indicates whether the question is hidden.	✔
communityId	String	The unique identifier of the community to which the question belongs.	✔
memberId	String	The unique identifier of the member associated with the question.	✔
directoryFields	bool	Indicates whether the question is part of directory fields.	✔
imageUrl	String	The URL of the image associated with the question.	✔
canAddOtherOptions	bool	Indicates whether additional options can be added to the question.	✔
questionChangeState	int	The change state of the question.	✔
tag	String	The tag associated with the question.	✔
rank	int	The rank or order of the question.	✔
isAnswerEditable	bool	Indicates whether the answer to the question is editable.
dropdownSelectionLimit	int	The limit on the number of selections in a dropdown question.	✔

Answer

The Answer class represents an answer provided by a member in response to a specific question within a community or a system. Below are the details of the Answer model:

Properties

Variable	Type	Description	Optional
answer	String	The text or content of the answer.
memberId	int	The unique identifier of the member providing the answer.
questionId	int	The unique identifier of the associated question.
communityId	int	The unique identifier of the community to which the question belongs.
imageUrl	String	The URL of an image associated with the answer.	✔