JSDoc: Namespace: roster

# Namespace: roster

## jsxc.gui.roster

Handle functions related to the gui of the roster

Source:
  - jsxc.lib.gui.js, line 1515

### Members

#### (static) loaded

True if all items are loaded

Source:
  - jsxc.lib.gui.js, line 1526

#### (static) ready

True if roster is initialised

Source:
  - jsxc.lib.gui.js, line 1523

### Methods

#### (static) _rename(bid, newname) → {undefined}

Rename buddy

##### Parameters:

Name | Type | Description
--- | --- | ---
`bid` | type |
`newname` | type | new name of buddy

Source:
  - jsxc.lib.gui.js, line 1850

##### Returns:

Type
  undefined

#### (static) add(bid)

Create roster item and add it to the roster

##### Parameters:

Name | Type | Description
--- | --- | ---
`bid` | String | bar jid

Source:
  - jsxc.lib.gui.js, line 1642

#### (static) empty()

Shows a text with link to add a new buddy.

Source:
  - jsxc.lib.gui.js, line 1931

#### (static) init() → {undefined}

Init the roster skeleton

Source:
  - jsxc.lib.gui.js, line 1534

##### Returns:

Type
  undefined

#### (static) insert(bid, li) → {undefined}

Insert roster item. First order: online > away > offline. Second order: alphabetical of the name

##### Parameters:

Name | Type | Description
--- | --- | ---
`bid` | type |
`li` | jquery | roster item which should be insert

Source:
  - jsxc.lib.gui.js, line 1730

##### Returns:

Type
  undefined

#### (static) noConnection()

Shows a text with link to a login box that no connection exists.

Source:
  - jsxc.lib.gui.js, line 1911

#### (static) purge(bid)

Removes buddy from roster and clean up

##### Parameters:

Name | Type | Description
--- | --- | ---
`bid` | String | bar compatible jid

Source:
  - jsxc.lib.gui.js, line 1786

#### (static) remove(bid) → {JQueryObject}

Removes buddy from roster

##### Parameters:

Name | Type | Description
--- | --- | ---
`bid` | String | bar jid

Source:
  - jsxc.lib.gui.js, line 1777

##### Returns:

Roster list element

Type
  JQueryObject

#### (static) rename(bid) → {undefined}

Create input element for rename action

##### Parameters:

Name | Type | Description
--- | --- | ---
`bid` | type |

Source:
  - jsxc.lib.gui.js, line 1807

##### Returns:

Type
  undefined

#### (static) reorder(bid) → {undefined}

Initiate reorder of roster item

##### Parameters:

Name | Type | Description
--- | --- | ---
`bid` | type |

Source:
  - jsxc.lib.gui.js, line 1767

##### Returns:

Type
  undefined

#### (static) toggle(state)

Toogle complete roster

##### Parameters:

Name | Type | Description
--- | --- | ---
`state` | string | Toggle to state

Source:
  - jsxc.lib.gui.js, line 1878