JSDoc: Namespace: roster

# Namespace: roster

## jsxc.gui. roster

Handle functions related to the gui of the roster

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

### Members

#### <static> loaded

  True if all items are loaded
  Source:
    - jsxc.lib.gui.js, line 1472

#### <static> ready

  True if roster is initialised
  Source:
    - jsxc.lib.gui.js, line 1469

### 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 1788

  ##### 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 1587

#### <static> empty()

  Shows a text with link to add a new buddy.
  Source:
    - jsxc.lib.gui.js, line 1864

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

  Init the roster skeleton
  Source:
    - jsxc.lib.gui.js, line 1480

  ##### 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 1672

  ##### Returns:

  Type
    undefined

#### <static> noConnection()

  Shows a text with link to a login box that no connection exists.
  Source:
    - jsxc.lib.gui.js, line 1849

#### <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 1724

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

  Removes buddy from roster

  ##### Parameters:

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

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

  ##### 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 1745

  ##### Returns:

  Type
    undefined

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

  Initiate reorder of roster item

  ##### Parameters:

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

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

  ##### Returns:

  Type
    undefined

#### <static> toggle(state)

  Toogle complete roster

  ##### Parameters:

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

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