Skip to content
GitLab
Projects
Groups
Snippets
Help
Loading...
Help
What's new
7
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Open sidebar
Linus Jahn
kaidan
Commits
8c7a34cc
Commit
8c7a34cc
authored
Jun 06, 2017
by
Linus Jahn
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Doc: Add RosterModel and MessageModel
parent
0bce0c53
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
47 additions
and
0 deletions
+47
-0
doc/kaidan_qml_api.md
doc/kaidan_qml_api.md
+47
-0
No files found.
doc/kaidan_qml_api.md
View file @
8c7a34cc
...
...
@@ -74,6 +74,35 @@ This will send the `message` to the `recipient`.
*
`message = string`
: The message to be sent.
## MessageModel
This is a QSqlTableModel. The table contains the following rows:
### `author = string`
The JID of author of the message.
### `author_resource = string`
The JID resource of the author of the message.
### `recipient = string`
The JID of the recipient of the message.
### `recipient_resource = string`
The JID resource of the recipient of the message.
### `timestamp = string`
The timestamp when the message was sent.
### `message = string`
The message body.
### `id = string`
The message id.
### `isDelivered = bool`
Is true, if the a delivery confirmation has arrived from the recipient's client.
## RosterController
The roster controller is for getting, editing and adding contacts.
...
...
@@ -93,6 +122,24 @@ This will send a request to remove the contact that has the given `jid`.
*
`jid = string`
: The bare JID of the contact to remove.
## RosterModel
This is a QSqlTableModel. The table contains the following rows:
### `jid = string`
The JID of the contact.
### `name = string`
The nick name for this contact.
### `lastExchanged = string`
The date on which the last time a message was exchanged. (You can use this for
sorting)
### `unreadMessages = int`
The number of unread messages from this contact.
## VCard
A VCard is used to store profile information as names, emails, telephone number,
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment