Difference between revisions of "SwivelReport Documentation"

Latest revision as of 12:52, 11 May 2017

Overview

Class name: SwivelReport

Namespace: swivelsecure.client

Encapsulation of a report request. Reports must be linked to a SwivelAdminAPIRequest instance. SwivelAdminAPIRequest is an interface implemented by SwivelAdminRequest and SwivelHelpdeskRequest.

Constructor

SwivelReport(SwivelAdminAPIRequest req)

req: The request to which the report applies

Methods

void RequestLocked()

Request a list of locked users

void RequestDisabled()

Request a list of disabled users

void RequestIdle(DateTime date)

Request a list of users that have not logged in since a specified date
date: The cutoff date

void RequestAll()

Request a list of all usernames in the current repository

void RequestAllDetailed()

Request a list of all users in the current repository, with user details.
NOTE: this method only works with "Normal" repositories, defined in the Repository -> Servers page. It will not list users created by an Agent.
The workaround to this is to create a dummy repository definition, of any type, with exactly the same name as the Agent.

void SetRepository(String repos)

Set the repository to which the report applies.
Only applies to SwivelHelpdeskRequest.

void RequestHistory(string username)

Add a request to view activity history for a specified user.
username: The name of the required user

void RequestHistory(List<string> usernames)

Add a request to view activity history for a specified list of users.
usernames: The names of the required users

XmlElement AsElement()

Generate the report request as XML.
This is used by the request, and should not need to be called directly.