Module prelude

Module prelude 

Source
Expand description

Re-exports everything that is needed to send commands, match events and destructure responses

Re-exports§

pub use crate::ClientApi as _;
pub use crate::ClientError;
pub use crate::ClientResult;

Structs§

AcceptingBusinessRequest
Connection progress events
AcceptingContactRequest
Connection progress events
AcceptingContactRequestResponse
ActiveUserResponse
AddressSettings
ApiAcceptContact
Connection commands
ApiAcceptMember
Group commands
ApiAddContact
Connection commands
ApiAddMember
Group commands
ApiBlockMembersForAll
Group commands
ApiChatItemReaction
Message commands
ApiConnect
Connection commands
ApiConnectPlan
Connection commands
ApiCreateGroupLink
Group link commands
ApiCreateMyAddress
Address commands
ApiDeleteChat
Chat commands
ApiDeleteChatItem
Message commands
ApiDeleteGroupLink
Group link commands
ApiDeleteMemberChatItem
Message commands
ApiDeleteMyAddress
Address commands
ApiDeleteUser
User profile commands
ApiGetGroupLink
Group link commands
ApiGroupLinkMemberRole
Group link commands
ApiJoinGroup
Group commands
ApiLeaveGroup
Group commands
ApiListContacts
Chat commands
ApiListGroups
Chat commands
ApiListMembers
Group commands
ApiMembersRole
Group commands
ApiNewGroup
Group commands
ApiRejectContact
Connection commands
ApiRemoveMembers
Group commands
ApiSendMessages
Message commands
ApiSetActiveUser
User profile commands
ApiSetAddressSettings
Address commands
ApiSetContactPrefs
User profile commands
ApiSetProfileAddress
Address commands
ApiShowMyAddress
Address commands
ApiUpdateChatItem
Message commands
ApiUpdateGroupProfile
Group commands
ApiUpdateProfile
User profile commands
BusinessLinkConnecting
Connection progress events
CancelFile
File commands
ChatCmdErrorResponse
ChatError
Error events
ChatErrors
Error events
ChatItemNotChangedResponse
ChatItemReaction
Message events
ChatItemReactionResponse
ChatItemUpdated
Message events
ChatItemUpdatedResponse
ChatItemsDeleted
Message events
ChatItemsDeletedResponse
ChatItemsStatusesUpdated
Message events
ChatRef
Used in API commands. Chat scope can only be passed with groups.
CmdOkResponse
ComposedMessage
Connect
Connection commands
ConnectedToGroupMember
Group events
ConnectionPlanResponse
ContactAlreadyExistsResponse
ContactConnected
Contact connection events
ContactConnecting
Connection progress events
ContactConnectionDeletedResponse
ContactDeletedByContact
Contact connection events
ContactDeletedResponse
ContactPrefsUpdatedResponse
ContactRequestRejectedResponse
ContactSndReady
Contact connection events
ContactUpdated
Contact connection events
ContactsListResponse
CreateActiveUser
User profile commands
CreatedConnLink
Syntax:
DeletedMember
Group events
DeletedMemberUser
Group events
GroupChatItemsDeleted
Message events
GroupCreatedResponse
GroupDeleted
Group events
GroupDeletedUserResponse
GroupLinkConnecting
Connection progress events
GroupLinkCreatedResponse
GroupLinkDeletedResponse
GroupLinkResponse
GroupMemberUpdated
Group events
GroupMembersResponse
GroupProfile
GroupUpdated
Group events
GroupUpdatedResponse
GroupsListResponse
InvitationResponse
JoinedGroupMember
Group events
JoinedGroupMemberConnecting
Connection progress events
LeftMember
Group events
LeftMemberUserResponse
ListUsers
User profile commands
MemberAcceptedByOther
Group events
MemberAcceptedResponse
MemberBlockedForAll
Group events
MemberRole
Group events
MembersBlockedForAllUserResponse
MembersRoleUserResponse
MessageError
Error events
NewChatItems
Message events
NewChatItemsResponse
NewMemberContactReceivedInv
Contact connection events
NewUser
Preferences
Profile
RcvFileAccepted
File events
RcvFileAcceptedResponse
RcvFileAcceptedSndCancelledResponse
RcvFileCancelledResponse
RcvFileComplete
File events
RcvFileDescrReady
File events
RcvFileError
File events
RcvFileSndCancelled
File events
RcvFileStart
File events
RcvFileWarning
File events
ReceiveFile
File commands
ReceivedContactRequest
Contact connection events
ReceivedGroupInvitation
Group events
SentConfirmationResponse
SentGroupInvitation
Connection progress events
SentGroupInvitationResponse
SentInvitationResponse
ShowActiveUser
User profile commands
SndFileCancelledResponse
SndFileCompleteXftp
File events
SndFileError
File events
SndFileWarning
File events
UpdatedMessage
User
UserAcceptedGroupSentResponse
UserContactLinkCreatedResponse
UserContactLinkDeletedResponse
UserContactLinkResponse
UserContactLinkUpdatedResponse
UserDeletedMembersResponse
UserInfo
UserJoinedGroup
Group events
UserProfileNoChangeResponse
UserProfileUpdatedResponse
UsersListResponse

Enums§

ApiAcceptContactResponse
ApiAcceptMemberResponse
ApiAddContactResponse
ApiAddMemberResponse
ApiBlockMembersForAllResponse
ApiChatItemReactionResponse
ApiConnectPlanResponse
ApiConnectResponse
ApiConnectResponses
ApiCreateGroupLinkResponse
ApiCreateMyAddressResponse
ApiDeleteChatItemResponse
ApiDeleteChatResponse
ApiDeleteChatResponses
ApiDeleteGroupLinkResponse
ApiDeleteMemberChatItemResponse
ApiDeleteMyAddressResponse
ApiDeleteUserResponse
ApiGetGroupLinkResponse
ApiGroupLinkMemberRoleResponse
ApiJoinGroupResponse
ApiLeaveGroupResponse
ApiListContactsResponse
ApiListGroupsResponse
ApiListMembersResponse
ApiMembersRoleResponse
ApiNewGroupResponse
ApiRejectContactResponse
ApiRemoveMembersResponse
ApiSendMessagesResponse
ApiSetActiveUserResponse
ApiSetAddressSettingsResponse
ApiSetContactPrefsResponse
ApiSetProfileAddressResponse
ApiShowMyAddressResponse
ApiUpdateChatItemResponse
ApiUpdateChatItemResponses
ApiUpdateGroupProfileResponse
ApiUpdateProfileResponse
ApiUpdateProfileResponses
BadResponseError
CIContent
CIDeleteMode
CancelFileResponse
CancelFileResponses
ChatDeleteMode
Syntax:
ChatInfo
ChatType
Syntax:
ConnectResponse
ConnectResponses
CreateActiveUserResponse
Event
GroupMemberRole
ListUsersResponse
MsgContent
MsgReaction
ReceiveFileResponse
ReceiveFileResponses
ShowActiveUserResponse
UndocumentedResponse

Traits§

AllowUndocumentedResponses
If you want to suffer handle undocumented responses you can use this extension trait on client API return values which moves Undocumented from Err to Ok variant.
ClientApi
ClientApiError