Common Models
Following are the common models used throughout the SDK. These models are referenced wherever required.
LMResponse
This is a wrapper class for all the responses returned by the SDK. It contains the following parameters:
Variable | Type | Description | Optional |
---|---|---|---|
success | bool | API success status | |
errorMessage | String? | Error message in case of failure | ✔️ |
data | dynamic | Object of specific response data class |
User
List of parameters used in User
Variable | Type | Description | Optional |
---|---|---|---|
id | int | unique id of the user | |
name | String | name of the user | |
imageUrl | String | profile image url of the user | ✔️ |
isGuest | bool | is user a guest | ✔️ |
userUniqueId | String | unique id of the user | |
organisationName | String | name of the organisation | ✔️ |
sdkClientInfo | SDKClientInfo | sdk client info | ✔️ |
updatedAt | int | timestamp of last update | ✔️ |
isOwner | bool | is user an owner | ✔️ |
customTitle | String | custom title of the user | ✔️ |
memberSince | String | date of joining the community | ✔️ |
route | String | route of the user | ✔️ |
state | int | state of the user | ✔️ |
communityId | int | unique id of the community | ✔️ |
createdAt | int | timestamp of user creation | ✔️ |
SDKClientInfo
List of parameters used in SDKClientInfo
Variable | Type | Description | Optional |
---|---|---|---|
community | int | unique id of the community | |
user | int | unique id of the user | |
userUniqueId | String | unique id of the user |
Community
List of parameters used in Community
Variable | Type | Description | Optional |
---|---|---|---|
id | int | unique id of the community | |
name | String | name of the community | |
imageUrl | String | profile image url of the community | ✔️ |
ChatRoom
List of parameters used in ChatRoom
Variable | Type | Description | Optional |
---|---|---|---|
id | int | unique id of the chatroom | |
title | String | title of the chatroom | |
header | String | header of the chatroom | |
communityId | int | unique id of the community | |
communityName | String | name of the community | |
chatroomImageUrl | String | profile image url of the chatroom | ✔️ |
autoFollowDone | bool | is auto follow done | ✔️ |
cardCreationTime | String | card creation time | ✔️ |
createdAt | int | timestamp of creation | ✔️ |
lastConversationId | int | unique id of last conversation | ✔️ |
date | String | date of the chatroom | ✔️ |
dateEpoch | int | epoch of the date | ✔️ |
dateTime | int | timestamp of the date | ✔️ |
followStatus | bool | is user following the chatroom | ✔️ |
includeMembersLater | bool | is members included later | ✔️ |
isPrivate | bool | is chatroom private | ✔️ |
isPrivateMember | bool | is user a private member | ✔️ |
isSecret | bool | is chatroom secret | ✔️ |
isTagged | bool | is chatroom tagged | ✔️ |
member | ChatRoomMember | member of the chatroom | ✔️ |
muteStatus | bool | is chatroom muted | ✔️ |
reactions | List<dynamic> | list of reactions | ✔️ |
secretChatroomLeft | bool | is secret chatroom left | ✔️ |
state | int | state of the chatroom | ✔️ |
type | int | type of the chatroom | ✔️ |
participantCount | int | count of participants | ✔️ |
ChatoomAction
List of parameters used in ChatoomAction
Variable | Type | Description | Optional |
---|---|---|---|
id | int | unique id of the chatroom action | |
title | String | title of the chatroom action |
Conversation
List of parameters used in Conversation
Variable | Type | Description | Optional |
---|---|---|---|
allowAddOption | bool | is add option allowed | ✔️ |
answer | String | answer of the conversation | ✔️ |
attachmentCount | int | count of attachments | ✔️ |
attachments | List<dynamic> | list of attachments | ✔️ |
attachmentsUploaded | bool | is attachments uploaded | ✔️ |
chatroomId | int | unique id of the chatroom | ✔️ |
communityId | int | unique id of the community | ✔️ |
createdAt | String | timestamp of creation | ✔️ |
createdEpoch | int | epoch of creation | ✔️ |
date | String | date of the conversation | ✔️ |
deletedByUserId | int | unique id of deleted user | ✔️ |
deviceId | String | unique id of the device | ✔️ |
endTime | int | end time of the conversation | ✔️ |
expiryTime | int | expiry time of the conversation | ✔️ |
hasFiles | bool | is conversation has files | ✔️ |
hasReactions | bool | is conversation has reactions | ✔️ |
id | int | unique id of the conversation | ✔️ |
internalLink | String | internal link of the conversation | ✔️ |
isAnonymous | bool | is conversation anonymous | ✔️ |
isEdited | bool | is conversation edited | ✔️ |
lastUpdated | int | timestamp of last update | ✔️ |
multipleSelectNo | int | multiple select number | ✔️ |
multipleSelectState | int | multiple select state | ✔️ |
ogTags | OgTags | tags of the conversation | ✔️ |
pollAnswerText | String | answer of the poll | ✔️ |
pollType | int | type of the poll | ✔️ |
replyChatroomId | int | unique id of the reply chatroom | ✔️ |
replyId | int | unique id of the reply | ✔️ |
state | int | state of the conversation | ✔️ |
temporaryId | String | unique id of the temporary conversation | ✔️ |
userId | int | unique id of the user | ✔️ |
memberId | int | unique id of the member | ✔️ |
toShowResults | bool | is show results | ✔️ |
pollTypeText | String | type of the poll text | ✔️ |
submitTypeText | String | type of the submit text | ✔️ |
isTimeStamp | bool | is time stamp | ✔️ |
Attachment
List of parameters used in Attachment
Variable | Type | Description | Optional |
---|---|---|---|
answerId | int | unique id of the answer | ✔️ |
createdAt | int | timestamp of creation | ✔️ |
dimensions | dynamic | dimensions of the attachment | ✔️ |
fileUrl | String | url of the file | ✔️ |
url | String | url of the attachment | ✔️ |
height | dynamic | height of the attachment | ✔️ |
id | int | unique id of the attachment | ✔️ |
index | int | index of the attachment | ✔️ |
meta | dynamic | meta of the attachment | ✔️ |
name | String | name of the attachment | ✔️ |
thumbnailUrl | String | thumbnail url of the attachment | ✔️ |
type | String | type of the attachment | ✔️ |
width | dynamic | width of the attachment | ✔️ |
UserTag
List of parameters used in UserTag
Variable | Type | Description | Optional |
---|---|---|---|
name | String | name of the user | ✔️ |
imageUrl | String | url of the image | ✔️ |
customTitle | String | custom title of the user | ✔️ |
id | int | unique id of the user | ✔️ |
isGuest | bool | is user guest | ✔️ |
userUniqueId | String | unique id of the user | ✔️ |
OgTags
List of parameters used in OgTags
Variable | Type | Description | Optional |
---|---|---|---|
description | String | description of the og tags | ✔️ |
image | String | image of the og tags | ✔️ |
title | String | title of the og tags | ✔️ |
url | String | url of the og tags | ✔️ |