329 lines
13 KiB
HTML
329 lines
13 KiB
HTML
<!doctype html>
|
|
<html class="no-js" lang="">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="x-ua-compatible" content="ie=edge">
|
|
<title>framadate-funky-frontend documentation</title>
|
|
<meta name="description" content="">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
|
|
<link rel="icon" type="image/x-icon" href="../images/favicon.ico">
|
|
<link rel="stylesheet" href="../styles/style.css">
|
|
</head>
|
|
<body>
|
|
|
|
<div class="navbar navbar-default navbar-fixed-top visible-xs">
|
|
<a href="../" class="navbar-brand">framadate-funky-frontend documentation</a>
|
|
<button type="button" class="btn btn-default btn-menu ion-ios-menu" id="btn-menu"></button>
|
|
</div>
|
|
|
|
<div class="xs-menu menu" id="mobile-menu">
|
|
<div id="book-search-input" role="search"><input type="text" placeholder="Type to search"></div> <compodoc-menu></compodoc-menu>
|
|
</div>
|
|
|
|
<div class="container-fluid main">
|
|
<div class="row main">
|
|
<div class="hidden-xs menu">
|
|
<compodoc-menu mode="normal"></compodoc-menu>
|
|
</div>
|
|
<!-- START CONTENT -->
|
|
<div class="content interface">
|
|
<div class="content-data">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<ol class="breadcrumb">
|
|
<li>Interfaces</li>
|
|
<li>DateOption</li>
|
|
</ol>
|
|
|
|
<ul class="nav nav-tabs" role="tablist">
|
|
<li class="active">
|
|
<a href="#info" role="tab" id="info-tab" data-toggle="tab" data-link="info">Info</a>
|
|
</li>
|
|
<li >
|
|
<a href="#source" role="tab" id="source-tab" data-toggle="tab" data-link="source">Source</a>
|
|
</li>
|
|
</ul>
|
|
|
|
<div class="tab-content">
|
|
<div class="tab-pane fade active in" id="c-info">
|
|
<p class="comment">
|
|
<h3>File</h3>
|
|
</p>
|
|
<p class="comment">
|
|
<code>src/app/config/PollConfig.ts</code>
|
|
</p>
|
|
|
|
|
|
|
|
<section>
|
|
<h3 id="index">Index</h3>
|
|
<table class="table table-sm table-bordered index-table">
|
|
<tbody>
|
|
<tr>
|
|
<td class="col-md-4">
|
|
<h6><b>Properties</b></h6>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="col-md-4">
|
|
<ul class="index-list">
|
|
<li>
|
|
<span class="modifier">Optional</span>
|
|
<a href="#date_object">date_object</a>
|
|
</li>
|
|
<li>
|
|
<a href="#literal">literal</a>
|
|
</li>
|
|
<li>
|
|
<a href="#timeList">timeList</a>
|
|
</li>
|
|
</ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</section>
|
|
|
|
|
|
|
|
<section>
|
|
<h3 id="inputs">Properties</h3>
|
|
<table class="table table-sm table-bordered">
|
|
<tbody>
|
|
<tr>
|
|
<td class="col-md-4">
|
|
<a name="date_object"></a>
|
|
<span class="name"><b>date_object</b><a href="#date_object"><span class="icon ion-ios-link"></span></a></span>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="col-md-4">
|
|
<code>date_object: <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/object" target="_blank" >object</a></code>
|
|
</code>
|
|
</td>
|
|
</tr>
|
|
|
|
|
|
<tr>
|
|
<td class="col-md-4">
|
|
<i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/object" target="_blank" >object</a></code>
|
|
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td class="col-md-4">
|
|
<i>Optional</i>
|
|
</td>
|
|
</tr>
|
|
|
|
|
|
|
|
|
|
</tbody>
|
|
</table>
|
|
<table class="table table-sm table-bordered">
|
|
<tbody>
|
|
<tr>
|
|
<td class="col-md-4">
|
|
<a name="literal"></a>
|
|
<span class="name"><b>literal</b><a href="#literal"><span class="icon ion-ios-link"></span></a></span>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="col-md-4">
|
|
<code>literal: <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code>
|
|
</code>
|
|
</td>
|
|
</tr>
|
|
|
|
|
|
<tr>
|
|
<td class="col-md-4">
|
|
<i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code>
|
|
|
|
</td>
|
|
</tr>
|
|
|
|
|
|
|
|
|
|
|
|
</tbody>
|
|
</table>
|
|
<table class="table table-sm table-bordered">
|
|
<tbody>
|
|
<tr>
|
|
<td class="col-md-4">
|
|
<a name="timeList"></a>
|
|
<span class="name"><b>timeList</b><a href="#timeList"><span class="icon ion-ios-link"></span></a></span>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="col-md-4">
|
|
<code>timeList: <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >any</a></code>
|
|
</code>
|
|
</td>
|
|
</tr>
|
|
|
|
|
|
<tr>
|
|
<td class="col-md-4">
|
|
<i>Type : </i> <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >any</a></code>
|
|
|
|
</td>
|
|
</tr>
|
|
|
|
|
|
|
|
|
|
|
|
</tbody>
|
|
</table>
|
|
</section>
|
|
</div>
|
|
|
|
|
|
<div class="tab-pane fade tab-source-code" id="c-source">
|
|
<pre class="line-numbers compodoc-sourcecode"><code class="language-typescript">import {environment} from "../../environments/environment";
|
|
import {DateChoice, defaultAnswers, otherDefaultDates, PollAnswer} from "./defaultConfigs";
|
|
|
|
export interface DateOption {
|
|
timeList: any;
|
|
literal: string;
|
|
date_object?: object;
|
|
}
|
|
|
|
const baseConfigValues = {
|
|
pollType: "classic",
|
|
title: "",
|
|
description: "",
|
|
myName: "",
|
|
myEmail: "",
|
|
};
|
|
|
|
|
|
/**
|
|
* configuration of the poll, add new fields at will
|
|
*/
|
|
export class PollConfig {
|
|
expiracyDateDefaultInDays = 60;
|
|
deletionDateAfterLastModification = 180;
|
|
step: number = 0; // step in the progress of creating a poll
|
|
stepMax: number = 3; // step max in the progress of creating a poll
|
|
pollType: string = 'dates';// classic or dates
|
|
title: string = 'titre';
|
|
description: string = 'ma description';
|
|
myName: string = 'mon pseudo';
|
|
myComment: string = 'wouah trop bien framadate!';
|
|
isAdmin: boolean = true;
|
|
myVoteStack: any;
|
|
myTempVoteStack = 0;
|
|
myEmail: string = "tktest@tktest.com";
|
|
myPolls: any = [];// list of retrieved polls from the backend api
|
|
// date specific poll, we have the choice to setup different hours (timeList) for all possible dates (dateList), or use the same hours for all dates
|
|
allowSeveralHours = 'true';
|
|
// access
|
|
visibility = 'link_only'; // visible to anyone with the link:
|
|
voteChoices = 'only_yes'; // possible answers to a vote choice: only "yes", "yes, maybe, no"
|
|
creationDate = new Date();
|
|
expirationDate = ''; // expiracy date
|
|
voteStackId = null; // id of the vote stack to update
|
|
pollId = null; // id of the current poll when created. data given by the backend api
|
|
pollSlug = null; // id of the current poll when created. data given by the backend api
|
|
currentPoll; // current poll selected with createPoll or getPoll of ConfigService
|
|
passwordAccess = 0;
|
|
password = '';
|
|
customUrl = ''; // custom slug in the url, must be unique
|
|
customUrlIsUnique = null; // given by the backend
|
|
urlSlugPublic = null;
|
|
urlPublic = environment.baseHref + '/#/poll/id/4';
|
|
urlAdmin = environment.baseHref + '/#/admin/d65es45fd45sdf45sd345f312sdf31sgfd345';
|
|
adminKey = ''; // key to change config of the poll
|
|
owner_modifier_token = ''; // key to change a vote stack
|
|
canModifyAnswers: boolean = true;// bool for the frontend selector
|
|
whoModifiesAnswers = "everybody";// everybody, self, nobody (= just admin)
|
|
whoCanChangeAnswers = 'everybody';// everybody, self, nobody (= just admin)
|
|
dateList: any = otherDefaultDates; // sets of days as strings, config to set identical time for days in a special days poll
|
|
timeList: DateChoice[] = otherDefaultDates; // ranges of time expressed as strings
|
|
|
|
answers: PollAnswer[] = defaultAnswers;
|
|
|
|
resetConfig() {
|
|
const self = this;
|
|
Object.keys(baseConfigValues).forEach((key) => {
|
|
self[key] = baseConfigValues[key];
|
|
})
|
|
}
|
|
}
|
|
</code></pre>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div><div class="search-results">
|
|
<div class="has-results">
|
|
<h1 class="search-results-title"><span class='search-results-count'></span> result-matching "<span class='search-query'></span>"</h1>
|
|
<ul class="search-results-list"></ul>
|
|
</div>
|
|
<div class="no-results">
|
|
<h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<!-- END CONTENT -->
|
|
</div>
|
|
</div>
|
|
|
|
<script>
|
|
var COMPODOC_CURRENT_PAGE_DEPTH = 1;
|
|
var COMPODOC_CURRENT_PAGE_CONTEXT = 'interface';
|
|
var COMPODOC_CURRENT_PAGE_URL = 'DateOption.html';
|
|
</script>
|
|
|
|
<script src="../js/libs/custom-elements.min.js"></script>
|
|
<script src="../js/libs/lit-html.js"></script>
|
|
<!-- Required to polyfill modern browsers as code is ES5 for IE... -->
|
|
<script src="../js/libs/custom-elements-es5-adapter.js" charset="utf-8" defer></script>
|
|
<script src="../js/menu-wc.js" defer></script>
|
|
|
|
<script src="../js/libs/bootstrap-native.js"></script>
|
|
|
|
<script src="../js/libs/es6-shim.min.js"></script>
|
|
<script src="../js/libs/EventDispatcher.js"></script>
|
|
<script src="../js/libs/promise.min.js"></script>
|
|
<script src="../js/libs/zepto.min.js"></script>
|
|
|
|
<script src="../js/compodoc.js"></script>
|
|
|
|
<script src="../js/tabs.js"></script>
|
|
<script src="../js/menu.js"></script>
|
|
<script src="../js/libs/clipboard.min.js"></script>
|
|
<script src="../js/libs/prism.js"></script>
|
|
<script src="../js/sourceCode.js"></script>
|
|
<script src="../js/search/search.js"></script>
|
|
<script src="../js/search/lunr.min.js"></script>
|
|
<script src="../js/search/search-lunr.js"></script>
|
|
<script src="../js/search/search_index.js"></script>
|
|
<script src="../js/lazy-load-graphs.js"></script>
|
|
|
|
|
|
</body>
|
|
</html>
|