forked from arjunmat/slack-chat
-
Notifications
You must be signed in to change notification settings - Fork 0
/
params.json
1 lines (1 loc) · 3.83 KB
/
params.json
1
{"name":"Slack-Chat","tagline":"A support chat feature for your website that integrates with #Slack","body":"### Slack-Chat.\r\nSlack-Chat is a jQuery plugin that integrates a support chat system with your web app allowing your users to communicate with your team on Slack effectively and address queries faster.\r\n\r\nWhen users send a message, it will show up as a chat in the Channel specified by you.\r\n\r\n### Requirements\r\nSlack-Chat requires MomentJS. (http://momentjs.com)\r\n\r\n### Installation\r\n1. Download and add the JavaScript and CSS files to your web-app.\r\n2. Call Slack-Chat on the element that triggers the chat system.\r\n````\r\nvar slackChatOptions = {\r\n apiToken: '',\t //#Slack Auth token. Required. \r\n\t channelId: '',\t\t//#Slack channel ID. Required.\r\n\t user: '',\t\t\t//name of the user. Required.\r\n\t userLink: '', \t\t//link to the user in the application - shown in #Slack\r\n\t userImg: '',\t\t//image of the user\r\n\t userId: '',\t\t\t//id of the user in the application\r\n\t sysImg: '',\t\t\t//image to show when the support team replies\r\n\t sysUser: '', //Required. \r\n\t queryInterval: 3000,\r\n\t chatBoxHeader: \"Need help? Talk to our support team right here\",\r\n\t slackColor: \"#36a64f\",\r\n\t messageFetchCount: 100,\r\n\t botUser: '',\t\t//username to post to #Slack. Required.\r\n\t sendOnEnter: true,\r\n\t disableIfAway: false,\r\n\t elementToDisable: null,\r\n\t heightOffset: 75,\r\n\t debug: false\r\n}\r\n\r\n$(<elem>).slackChat(slackChatOptions);\r\n````\r\n### Options\r\n\r\n**apiToken** (Required)\r\n\r\nYour Slack Token. Generate one at https://api.slack.com/web if you don't have one.\r\n\r\n**channelId** (Required)\r\n\r\nID of the Slack Channel the messages should appear in.\r\n\r\n**user** (Required)\r\n\r\nName of the user.\r\n\r\n**userLink**\r\n\r\nLink to the user in your web-app. This will be show in Slack for quick reference for your support team.\r\n\r\n**userImg**\r\n\r\nA link to the profile image of the user.\r\n\r\n**userId**\r\n\r\nYour web-app ID of the user. For reference for your support team.\r\n\r\n**sysUser**(Required)\r\n\r\nThe text that will be displayed when your support team writes on the channel.\r\n\r\n**sysImg**\r\n\r\nThe image to be displayed when your support team writes on the channel.\r\n\r\n**queryInterval**\r\n\r\nPolling interval on the channel. Default: 3000\r\n\r\n**chatBoxHeader**\r\n\r\nCustomize the header HTML on the Chat Strip\r\n\r\nDefault:\"Need help? Talk to our support team right here\"\r\n\r\n**slackColor**\r\n\r\nA hex color code used to identify messages from Slack-Chat in Slack\r\n\r\n**messageFetchCount**\r\n\r\nNumber of messages to fetch for each poll.\r\n\r\nDefault: 100\r\n\r\n**botUser** (Required)\r\n\r\nA name that messages will be posted on Slack as.\r\n\r\n**sendOnEnter**\r\n\r\nSend the message when the user presses enter on the textbox.\r\n\r\nDefault: true\r\n\r\n**disableIfAway**\r\n\r\nDisable the Support if there are no online users in your Slack team\r\n\r\n**elementToDisable**\r\n\r\nThe jQuery element that must be disabled. Ex. $('.slackChatTrigger')\r\n\r\nUsed only in conjunction with disableIfAway\r\n\r\n**heightOffset**\r\n\r\nTo adjust the height of the message window in pixels.\r\n\r\nDefault: 75\r\n\r\n**debug**\r\n\r\nShows a few debug messages if set to true.\r\n\r\nDefault: false\r\n\r\n### Try it yourself here\r\nTry a demo here. http://slack-chat.improvi.in\r\n\r\n### Authors and Contributors\r\nCreated by Arjun Mathai. Send any error logs, feature requests, etc to [email protected]","google":"UA-33221195-3","note":"Don't delete this file! It's used internally to help with page regeneration."}