mirror of https://github.com/vector-im/riot-web
44 lines
1.3 KiB
TypeScript
44 lines
1.3 KiB
TypeScript
/*
|
|
Copyright 2020 Nurjin Jafar
|
|
Copyright 2020 Nordeck IT + Consulting GmbH.
|
|
|
|
Licensed 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.
|
|
*/
|
|
|
|
export type Effect<TOptions extends { [key: string]: any }> = {
|
|
/**
|
|
* one or more emojis that will trigger this effect
|
|
*/
|
|
emojis: Array<string>;
|
|
/**
|
|
* the matrix message type that will trigger this effect
|
|
*/
|
|
msgType: string;
|
|
/**
|
|
* the room command to trigger this effect
|
|
*/
|
|
command: string;
|
|
/**
|
|
* a function that returns the translated description of the effect
|
|
*/
|
|
description: () => string;
|
|
/**
|
|
* a function that returns the translated fallback message. this message will be shown if the user did not provide a custom message
|
|
*/
|
|
fallbackMessage: () => string;
|
|
/**
|
|
* animation options
|
|
*/
|
|
options: TOptions;
|
|
};
|