The Subscriber class provides access to subscriber information, including custom subscriber preferences.
Note: Group code and other sensitive information is not included in the XML (except in
Subscriber::fromid method).
XML Elements<Name>- Subscriber Name
<Id>- Subscriber ID
<GroupCode>- (Only returned in Subscriber::fromid method) Subscriber group code
<LoginMethod>| Value | Description |
|---|
| refworks | RefWorks Login |
| rwathens | Uses Athens for login |
| rwshibboleth | Uses Shibboleth for login |
<SSLLevel>| Value | Description |
|---|
| loginOnly | Only login and new user and update user pages use SSL |
| fullTime | All pages use SSL |
| noSSL | No SSL used anywhere in application |
<RefShare>| Value | Description |
|---|
| noRefShare | Subscriber does not have RefShare |
| validIPOnly | RefShares can only be viewed from valid IPs |
| public | RefShares can be views from anywhere |
<HelpURL>- URL that takes users of this subscriber to a specific help page
<SiteRWInfoURL>- URL to the subscriber's Refworks information page
<PreferredUI>- Subscriber's preferred user interface
| Value | Description |
|---|
| 1 | RefWorks Classic only |
| 2 | RefWorks 2.0 only |
| 3 | Have option to switch; default to RefWorks Classic |
| 4 | Have option to switch; default to RefWorks 2.0 |
<CustomLoginURL>- URL to display with the subscriber's information.
<AllowNewAccountCreation>- Specifies if user's is allowed to create new accounts.
| Value | Description |
|---|
| true | Users is allowed to create new accounts |
| false | Users is not allowed create new accounts |
Subscriber Class