GUACAMOLE-462: Add JavaScript objects for REST API representations of activity logs.

This commit is contained in:
Michael Jumper
2022-02-10 12:32:31 -08:00
parent b80d8da1bb
commit 6874f9c6bd
2 changed files with 123 additions and 0 deletions

View File

@@ -0,0 +1,89 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
/**
* Service which defines the ActivityLog class.
*/
angular.module('rest').factory('ActivityLog', [function defineActivityLog() {
/**
* The object returned by REST API calls when representing a log or
* recording associated with a connection's usage history, such as a
* session recording or typescript.
*
* @constructor
* @param {ActivityLog|Object} [template={}]
* The object whose properties should be copied within the new
* ActivityLog.
*/
var ActivityLog = function ActivityLog(template) {
// Use empty object by default
template = template || {};
/**
* The type of this ActivityLog.
*
* @type {string}
*/
this.type = template.type;
/**
* A human-readable description of this log.
*
* @type {TranslatableMessage}
*/
this.description = template.description;
};
/**
* All possible types of ActivityLog.
*
* @type {!object.<string, string>}
*/
ActivityLog.Type = {
/**
* A Guacamole session recording in the form of a Guacamole protocol
* dump.
*/
GUACAMOLE_SESSION_RECORDING : 'GUACAMOLE_SESSION_RECORDING',
/**
* A text log from a server-side process, such as the Guacamole web
* application or guacd.
*/
SERVER_LOG : 'SERVER_LOG',
/**
* A text session recording in the form of a standard typescript.
*/
TYPESCRIPT : 'TYPESCRIPT',
/**
* The timing file related to a typescript.
*/
TYPESCRIPT_TIMING : 'TYPESCRIPT_TIMING'
};
return ActivityLog;
}]);

View File

@@ -38,6 +38,23 @@ angular.module('rest').factory('ConnectionHistoryEntry', [function defineConnect
// Use empty object by default // Use empty object by default
template = template || {}; template = template || {};
/**
* An arbitrary identifier that uniquely identifies this record
* relative to other records in the same set, or null if no such unique
* identifier exists.
*
* @type {string}
*/
this.identifier = template.identifier;
/**
* A UUID that uniquely identifies this record, or null if no such
* unique identifier exists.
*
* @type {string}
*/
this.uuid = template.uuid;
/** /**
* The identifier of the connection associated with this history entry. * The identifier of the connection associated with this history entry.
* *
@@ -103,6 +120,23 @@ angular.module('rest').factory('ConnectionHistoryEntry', [function defineConnect
*/ */
this.active = template.active; this.active = template.active;
/**
* Arbitrary name/value pairs which further describe this history
* entry. The semantics and validity of these attributes are dictated
* by the extension which defines them.
*
* @type {!object.<string, string>}
*/
this.attributes = template.attributes;
/**
* All logs associated and accessible via this record, stored by their
* corresponding unique names.
*
* @type {!object.<string, ActivityLog>}
*/
this.logs = template.logs;
}; };
/** /**