com.avaya.ccs.api

## Interface OffsiteSettingsI

-     public interface OffsiteSettingsI

  The `OffsiteSettingsI` object represents the offite settings for the user that are administered in the Contact Center.

- - ### Method Summary

    All Methods Instance Methods Abstract Methods
    Modifier and Type | Method and Description
    --- | ---
    `OffsiteMode` | `getMode()` The current `OffsiteMode` as administered in the Contact Center for the user.
    `java.util.List<java.lang.String>` | `getPhones()` A list containing the offsite phone numbers that are administered for the user in the Contact Center.
    `boolean` | `isAlternatePhoneAllowed()` An alternate phone is a phone that is not administered for the user in the Contact Center.

- - ### Method Detail

    - #### getMode

          OffsiteMode getMode()

      The current `OffsiteMode` as administered in the Contact Center for the user.
      Returns:
        offsite mode selected for the user

    - #### getPhones

          java.util.List<java.lang.String> getPhones()

      A list containing the offsite phone numbers that are administered for the user in the Contact Center.

      If `isAlternatePhoneAllowed()` returns false, then the user must select one of these adminstered phones when invoking `UserI.loginOffsite(java.lang.String, java.lang.String)`.

      Returns:
        a list of administered offsite phone numbers or an empty list if no offsite phones are administered

    - #### isAlternatePhoneAllowed

          boolean isAlternatePhoneAllowed()

      An alternate phone is a phone that is not administered for the user in the Contact Center.

      If `true` the user can supply another phone number when invoking `UserI.loginOffsite(java.lang.String, java.lang.String)` that is not in the administered phones list returned by `getPhones()`

      Returns:
        `true` if the user is allowed to use an alernate phone, `false` if they are not