mirror of
https://gitlab.com/openstapps/openstapps.git
synced 2026-01-09 11:12:52 +00:00
82 lines
1.9 KiB
TypeScript
82 lines
1.9 KiB
TypeScript
/*
|
|
* Copyright (C) 2018 StApps
|
|
* This program is free software: you can redistribute it and/or modify it
|
|
* under the terms of the GNU General Public License as published by the Free
|
|
* Software Foundation, version 3.
|
|
*
|
|
* This program is distributed in the hope that it will be useful, but WITHOUT
|
|
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
|
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
|
|
* more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License along with
|
|
* this program. If not, see <https://www.gnu.org/licenses/>.
|
|
*/
|
|
import {SCAbstractRoute} from '../../../Route';
|
|
import {SCMessage} from '../../../things/Message';
|
|
|
|
/**
|
|
* User feedback
|
|
*/
|
|
export interface SCFeedbackRequest extends SCMessage {
|
|
/**
|
|
* Meta data that helps to understand the feedback
|
|
*/
|
|
metaData: {
|
|
/**
|
|
* Whether or not the user enabled the debug mode
|
|
*/
|
|
debug?: boolean;
|
|
|
|
/**
|
|
* Platform identifier
|
|
*/
|
|
platform: string;
|
|
|
|
/**
|
|
* Scope/app state at feedback invocation
|
|
*/
|
|
scope: any;
|
|
|
|
/**
|
|
* Whether or not the feedback is sendable
|
|
*/
|
|
sendable?: boolean;
|
|
|
|
/**
|
|
* App state that feedback was invoked from
|
|
*/
|
|
state: any;
|
|
|
|
/**
|
|
* User agent
|
|
*/
|
|
userAgent: string;
|
|
|
|
/**
|
|
* StApps version string
|
|
*/
|
|
version: string;
|
|
};
|
|
}
|
|
|
|
/**
|
|
* Route for feedback submission
|
|
*/
|
|
export class SCFeedbackRoute extends SCAbstractRoute {
|
|
constructor() {
|
|
super();
|
|
this.errorNames = [
|
|
'SCInternalServerErrorResponse',
|
|
'SCMethodNotAllowedErrorResponse',
|
|
'SCUnsupportedMediaTypeErrorResponse',
|
|
'SCValidationErrorResponse',
|
|
];
|
|
this.method = 'POST';
|
|
this.requestBodyName = 'SCFeedbackRequest';
|
|
this.responseBodyName = 'SCFeedbackResponse';
|
|
this.statusCodeSuccess = 204;
|
|
this.urlFragment = '/feedback';
|
|
}
|
|
}
|