Welcome to Tigase Messenger for iOS

1. Welcome

Tigase Team <team@tigase.net> :toc: :numbered: :website: http://tigase.net :Date: 2017-04-10

Welcome to the documentation for Tigase Messenger for iOS.

1.1. Minimum Requirements

Tigase Messenger for iOS requires an apple device running iOS v9 or later. Compatable devices are listed below:

iPhone
- iPhone 4S
- iPhone 5
- iPhone 5C
- iPhone 5S
- iPhone 6
- iPhone 6 Plus
- iPhone 6S
- iPhone 6S Plus
- iPhone 7
- iPhone 7 Plus
- iPhone SE

iPod Touch
- iPod Touch (5th generation)
- iPod Touch (6th generation)

iPad
- iPad 2
- iPad (3rd generation)
- iPad (4th generation)
- iPad Air
- iPad Air 2
- iPad Mini (1st generation)
- iPad Mini 2
- iPad Mini 3
- iPad Mini 4
- iPad Pro

1.2. Installation

Tigase Messenger for iOS can be installed the same way any apple approved app can be found: through the appstore. Search for Tigase in the store search function and then tap install and follow the prompts to install Tigase Messenger.

1.3. Account Setup

Upon running Tigase Meseenger for iOS for the first time, you will be greeted with the following screen:

Home

Your options are to register for a new account, or to use an existing account.

1.3.1. Registering for a New Account

The application supports creating a new account registration using in-band registration. This means that on servers supporting it, you can sign up for a new account straight from the client! A list of servers that support this is located here.

register

Choose your username and add the appropiate domain, and enter the password for the account.

Once you tap Register, the application will connect and register your account with the server.

1.3.2. Use an Existing Account

If you already have an XMPP account on a server, select this option to login usint Tigase Messenger for iOS. Enter your username and password as normal and tap Save to add the account.

Note
Your device name will serve as the resource for your account. iPad or iPhone will automatically be used as the resource.

You may recieve certificate errors from servers that may not have certificate chains installed, invalid, or expired certificates. Servers with these errors will ask the user to accept or deny these security exceptions:

certerr

2. Tigase Messenger for iOS Interface

Tigase Team <team@tigase.net> :toc: :numbered: :website: http://tigase.net :Date: 2017-04-10

The menu interface for Tigase Messenger for iOS is broken up into three main panels; Recent, Contacts and More. This can be brought up from any screen by swiping right from the left side of the screen, or tapping the back option on the top left.

2.1. Recent

The recent menu displays recent conversations with other users, and also serves as a way to navigate between multi-user chatrooms (MUCs). Each conversation will be displayed here along with an icon indicating user or room status.

recent

Tapping one of these conversations will bring up the chat, MUC or one on one. This panel also serves as an archive of sorts, and previous conversations with users will be accessable in this panel.

Note
Conversations will only be saved if they took place on this device, it uses local storage only and cannot retrieve messages from the server using message archiving or offline messages.

You may clear conversations from the archive by dragging the name or MUC conversation to the left and selecting delete. If you are removing a MUC chat, you will leave the chatroom.

2.1.1. New/Join MUC

Tapping the plus button on the top right will bring up the new/join muc panel. This interface will allow you to either join an existing or create a new MUC on your chosen server.

joinchat
  • Account: This is the account that will handle data for the MUC chatroom. This is available for users who have multiple accounts logged in.

  • Server: The server the chatroom is located on, in many cases the muc server will be muc.servername.com, but may be different.

  • Room: The name of the chatroom you wish to create or join.

  • Nickname: Your name for use inside the MUC. This will become yournickname@muc.server.com. MUC conversations do not leak your XMPP account, so a nickname is required.

  • Password: The password for the MUC room. If you are creating a new chatroom, this will serve as the chat room password.

Once you are finished, tap Join and you will join, or the room will be opened for you.

recent2

The recent panel will now display the chatroom, tap it to enter the MUC interface.

When in a chatroom, you may view the occupants by tapping Occupants, and will be given a list and statuses of the room participants.

occupants

2.2. Contacts

The contacts panel serves as your Roster, displaying all the contacts you have on your roster, and displaying statuses along with thier names. Tigase Messenger for iOS supports vCard-Temp Avatars and will retrieve them if they are uploaded by a user.

roster

Contacts with green icons are available or free to chat status.
Contacts with yellow icons are away or extended away.
Contacts with red icons are in do not disturb status.
Contacts with grey icons are offline or unavailable.

Note that contacts will remain grey if you decide not to allow presence notifications in the settings.

You may remove contacts by dragging a contact to the left and tapping Delete. This will remove the contact from your roster, and remove any presence sharing permissions from the contact. You may also remove multiple contacts by tapping Edit, and then tapping the remove symbols for contacts you wish to remove.

deluser

You may also filter contacts by status by selecting All to display all users, or Available to hide users that are offline or unavailable.

2.2.1. Adding a contact

To add a contact, tap the plus button in the upper left and the add contact screen will show.

adduserfull

First, select the account roster you wish the new contact to be added too. Then type in the JID of the user, do not use resources, just bare JID. You may enter a friendly nickname for the contact to be added to your roster, this is optional. When adding users, you have two options to select:

  • Send presence updates - This will allow sending of presence status and changes to this user on your roster. You may disable this to reduce network usage, however you will not be able to obtain status information.

  • Receive presence updates - Turning this on will enable the applications to send presence changes to this person on the roster. You may disable this to reduce network usage, however they will not receieve notifications if you turn off the phone

Note
These options are on by default and enable Tigase Messenger for iOS to behave like a traditional client.

If you do decide to receieve presence updates when adding a new contact, you will be presented with this screen when they add you back:

presreq

By tapping yes, you will recieve notifications of presence changes from your contact. This subscription will be maintained by the server, and will stay active with your roster.

2.3. More

The more panel is your program and account settings panel, from here you can change program settings and general account information.

settings

2.3.1. Accounts

This will list your current accounts, if an avatar has been defined for the account, it will show on the left side but by default the Tigase logo will be used. If you wish to remove an account, swipe left and select Delete. You will be asked for a confirmation whether you want to remove it from the application, and if the server supports it, you may delete it from the server removing roster, presence subscriptions, and potentially saved history.

Delacct
Warning
Deleting your account from the server is a permanent and non-reversible action.

You may also add an account from this screen.

2.3.2. Status

Below accounts is a status setting for all connected and online accounts. Editing this text section will change the <show> tags in your status, you will not be able to change your status tags as they are managed automatically.

status

To save data usage, your account status will be managed automatically using the following rules:

Status

Behavior

Online

Application has focus on the device.

Away / XA

Application is running in the background.

Offline

Application is killed or disconnected. If the device is turned off for a period of time, this will also set status to offline.

2.3.3. Settings

Below are some settings for the operation and behavior of the application.

  • Delete Chat history on chat close:
    If this is enabled, when you close chats from the recent screen, all local history on the device will be deleted. This does not affect operation of offline or server-stored message archives.

  • Message carbons:
    Enables or disables message carbons to deliver to all resources. This is on by default, however some servers may not support this.

  • Display contacts in groups:
    Whether to use display contacts in groups defined by roster. If this is disabled, contacts will be listed in alphabetical order.

  • Display "Hidden" group:
    If you are using groups, you may choose to display contacts that are hidden, such as offline or blocked contacts.

  • Subscribe to new contact presence:
    If this option is on, new contacts adding you will have recieve a request from the application subscribing to thier presence as well. You may disable this if you are not interested in receiving presence information from other contacts, this can reduce data use.

    = Advanced Options Tigase Team <team@tigase.net> :toc: :numbered: :website: http://tigase.net :Date: 2017-05-26

This section contains information about advanced settings and options that are available to the application, but may not be typically considered for users.

2.4. Push Component Support

Tigase Messenger for iOS supports XEP-0357 Push Notifications which will receive notifications even when accounts are logged off. Devices must be registered for push notifications and must register them VIA the Tigase XMPP Push Component. This can be done using an ad-hoc command sent to the hosting component. Tigase push component has a specific ad-hoc command known as register-device for this purpose.

Deregistration of a device may be accomplished by a similar ad-hoc command, using the unregister-device command on the Tigase push component.

For more information on the push component and its' capabilities, visit push component documentation.