@atomist/cortex/ChatChannel.ts

Atomist Cortex model TypeScript typings

/*
 * Copyright 2015-2017 Atomist Inc.
 *
 * 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.
 */

import { TreeNode, GraphNode, FormatInfo, PathExpressionEngine } from "@atomist/rug/tree/PathExpression";
import { ProjectContext } from "@atomist/rug/operations/ProjectEditor";
import { ChannelLink } from "./ChannelLink";
import { ChatId } from "./ChatId";
import { ChatTeam } from "./ChatTeam";
import { Repo } from "./Repo";
export { ChatChannel };

/**
 * Type ChatChannel
 */
interface ChatChannel extends GraphNode {

    /**
     * botInvitedSelf
     *
     * @property {boolean} botInvitedSelf
     */
    readonly botInvitedSelf: boolean;

    /**
     * createdBy - ChatChannel -> ChatId
     *
     * @property {ChatId} createdBy
     */
    readonly createdBy: ChatId;

    /**
     * id
     *
     * @property {string} id
     */
    readonly id: string;

    /**
     * isDefault
     *
     * @property {boolean} isDefault
     */
    readonly isDefault: boolean;

    /**
     * links - ChatChannel -> ChannelLink
     *
     * @property {ChannelLink[]} links
     */
    readonly links: ChannelLink[];

    /**
     * members - ChatChannel -> ChatId
     *
     * @property {ChatId[]} members
     */
    readonly members: ChatId[];

    /**
     * name
     *
     * @property {string} name
     */
    readonly name: string;

    /**
     * normalizedName
     *
     * @property {string} normalizedName
     */
    readonly normalizedName: string;

    /**
     * provider
     *
     * @property {string} provider
     */
    readonly provider: string;

    /**
     * repos - ChatChannel -> Repo
     *
     * @property {Repo[]} repos
     */
    readonly repos: Repo[];

    /**
     * team - ChatChannel -> ChatTeam
     *
     * @property {ChatTeam} team
     */
    readonly team: ChatTeam;

}