diff --git a/docs/html/functions.html b/docs/html/functions.html index b5fbb63d..3dd2aab5 100644 --- a/docs/html/functions.html +++ b/docs/html/functions.html @@ -97,18 +97,9 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
Here is a list of all documented class members with links to the class documentation for each member:

- m -

"Normal" chat IDs are larger than these special IDs (larger than MR_CHAT_ID_LAST_SPECIAL).

- - - -
-
- - - - -
int mrchat_t::m_type
-
- -

Chat type.

-
    -
  • MR_CHAT_TYPE_NORMAL (100) - a normal chat is a chat with a single contact, chats_contacts contains one record for the user, MR_CONTACT_ID_SELF (see mrcontact_t::m_id) is not added.
    • -
  • MR_CHAT_TYPE_GROUP (120) - a group chat, chats_contacts conain all group members, incl. MR_CONTACT_ID_SELF
    • -
-

If the chat type is not set, it is MR_CHAT_TYPE_UNDEFINED (0).

- -
-
- -
-
- - - - -
char* mrchat_t::m_name
-
- -

Name of the chat.

-

For one-to-one chats, this is the name of the contact. For group chats, this is the name given eg. to mrmailbox_create_group_chat() or received by a group-creation message.

-

To change the name, use mrmailbox_set_chat_name()

-

NULL if unset.

- -
-
- -
-
- - - - -
time_t mrchat_t::m_draft_timestamp
-
- -

Timestamp of the draft.

-

The draft itself is placed in mrchat_t::m_draft_text. To save a draft for a chat, use mrmailbox_set_draft()

-

0 if there is no draft.

- -
-
- -
-
- - - - -
char* mrchat_t::m_draft_text
-
- -

The draft text.

-

The timetamp of the draft is placed in mrchat_t::m_draft_timestamp. To save a draft for a chat, use mrmailbox_set_draft()

-

NULL if there is no draft.

- -
-
- -
-
- - - - -
int mrchat_t::m_archived
-
- -

Flag for the archived state.

-

0=normal chat, not archived, not sticky.

-

1=chat archived

-

2=chat sticky (reserved for future use, if you do not support this value, just treat the chat as a normal one)

-

To archive or unarchive chats, use mrmailbox_archive_chat(). If chats are archived, this should be shown in the UI by a little icon or text, eg. the search will also return archived chats.

-
The documentation for this struct was generated from the following files:
    diff --git a/docs/html/structmrcontact__t-members.html b/docs/html/structmrcontact__t-members.html index 1d287422..9ce00db0 100644 --- a/docs/html/structmrcontact__t-members.html +++ b/docs/html/structmrcontact__t-members.html @@ -93,7 +93,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); mrcontact_get_display_name(mrcontact_t *contact)mrcontact_t mrcontact_get_name(mrcontact_t *contact)mrcontact_t mrcontact_get_name_n_addr(mrcontact_t *contact)mrcontact_t - mrcontact_is_blocked(mrcontact_t *contact)mrcontact_t + mrcontact_is_blocked(mrcontact_t *contact)mrcontact_t mrcontact_unref(mrcontact_t *contact)mrcontact_t diff --git a/docs/html/structmrcontact__t.html b/docs/html/structmrcontact__t.html index 049cd9a6..ff8fda64 100644 --- a/docs/html/structmrcontact__t.html +++ b/docs/html/structmrcontact__t.html @@ -112,9 +112,9 @@ Public Member Functions char * mrcontact_get_name_n_addr (mrcontact_t *contact)  Get a summary of name and address. More...
      -char * mrcontact_is_blocked (mrcontact_t *contact) - Check if a contact is blocked. More...
    -  +int mrcontact_is_blocked (mrcontact_t *contact) + Check if a contact is blocked. More...
    +  @@ -259,12 +259,12 @@ Public Attributes - +

    Public Attributes

    - + diff --git a/docs/html/structmrmailbox__t.html b/docs/html/structmrmailbox__t.html index f649463f..91028182 100644 --- a/docs/html/structmrmailbox__t.html +++ b/docs/html/structmrmailbox__t.html @@ -380,7 +380,7 @@ Public Attributes - +
    char * mrcontact_is_blocked int mrcontact_is_blocked ( mrcontact_t *  contact)
    userdatacan be used by the client for any purpuse. He finds it later in mrmailbox__t::m_userdata().
    os_nameis only for decorative use and is shown eg. in the X-Mailer header in the form "Delta Chat <version> for <osName>"
    os_nameis only for decorative use and is shown eg. in the X-Mailer: header in the form "Delta Chat <version> for <os_name>". You can give the name of the operating system and/or the used environment here. It is okay to give NULL, in this case X-Mailer: header is set to "Delta Chat <version>".
    @@ -1277,7 +1277,7 @@ Public Attributes

    Save a draft for a chat.

    -

    To get the draft for a given chat ID, use mrchat_t::m_draft_text

    +

    To get the draft for a given chat ID, use mrchat_t::m_draft_text

    Parameters
    @@ -1396,7 +1396,7 @@ Public Attributes

    Archive or unarchive a chat.

    Archived chats are not included in the default chatlist returned by mrmailbox_get_chatlist(). Instead, if there are any archived chats, the pseudo-chat with the chat_id MR_CHAT_ID_ARCHIVED_LINK will be added the the end of the chatlist.

    To get a list of archived chats, use mrmailbox_get_chatlist() with the flag MR_GCL_ARCHIVED_ONLY.

    -

    To find out the archived state of a given chat, use mrchat_t::m_archived

    +

    To find out the archived state of a given chat, use mrchat_t::m_archived

    Calling this function usually results in the event MR_EVENT_MSGS_CHANGED

    Parameters
    mailboxThe mailbox object as returned from mrmailbox_new().
    @@ -1900,7 +1900,7 @@ Public Attributes
    Parameters
    - +
    mailboxMailbox object as created by mrmailbox_new().
    chat_nameThe name of the group chat to create. The name may be changed later using mrmailbox_set_chat_name(). To find out the name of a group later, see mrchat_t::m_name
    chat_nameThe name of the group chat to create. The name may be changed later using mrmailbox_set_chat_name(). To find out the name of a group later, see mrchat_t::m_name