{"id":21406690,"url":"https://github.com/ringcentral/ringcentral-notification-app-helper","last_synced_at":"2025-03-16T17:16:50.919Z","repository":{"id":143906500,"uuid":"352482421","full_name":"ringcentral/ringcentral-notification-app-helper","owner":"ringcentral","description":"A module used for communicate with RingCentral app in RingCentral notification integration","archived":false,"fork":false,"pushed_at":"2021-09-16T10:34:08.000Z","size":112,"stargazers_count":2,"open_issues_count":1,"forks_count":1,"subscribers_count":7,"default_branch":"main","last_synced_at":"2024-04-25T05:42:28.635Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ringcentral.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-03-29T01:35:53.000Z","updated_at":"2021-09-16T10:33:49.000Z","dependencies_parsed_at":null,"dependency_job_id":"27709445-5b79-4863-ac66-ee5b39c67268","html_url":"https://github.com/ringcentral/ringcentral-notification-app-helper","commit_stats":null,"previous_names":["ringcentral/ringcentral-notification-integration-helper"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ringcentral%2Fringcentral-notification-app-helper","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ringcentral%2Fringcentral-notification-app-helper/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ringcentral%2Fringcentral-notification-app-helper/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ringcentral%2Fringcentral-notification-app-helper/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ringcentral","download_url":"https://codeload.github.com/ringcentral/ringcentral-notification-app-helper/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243902321,"owners_count":20366262,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-22T16:41:56.272Z","updated_at":"2025-03-16T17:16:50.885Z","avatar_url":"https://github.com/ringcentral.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# RingCentral notification app helper\n\n[![Build Status](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Fatrox%2Fsync-dotenv%2Fbadge)](https://github.com/ringcentral/ringcentral-notification-integration-helper/actions)\n[![Coverage Status](https://coveralls.io/repos/github/ringcentral/ringcentral-notification-integration-helper/badge.svg?branch=release)](https://coveralls.io/github/ringcentral/ringcentral-notification-integration-helper?branch=release)\n\nA module to help with communication with with RingCentral app in RingCentral notification app with UI.\n\n## APIs and uses\n\n```bash\nnpm i ringcentral-notification-integration-helper -D\n```\n\n```js\nimport {\n  RingCentralNotificationIntegrationHelper\n} from 'ringcentral-notification-integration-helper'\n// or\n/*\nconst {\n  RingCentralNotificationIntegrationHelper\n} = require('ringcentral-notification-integration-helper')\n*/\n\nconst app = new RingCentralNotificationIntegrationHelper()\n\n// Notify RingCentral app that the integration can submit or not\n// so RingCentral app can enable or disable submit button in RingCentral app UI\napp.send({\n  canSubmit: true // or false if can not submit\n})\n\n// Receive message from RingCentral app that\n// user already click submit button so integration can proceed to submit.\napp.on('submit', async function someSubmitFunction (e) {\n  console.log(e.data.payload)\n  // do something like submit\n  const submitSuccess = await doSubmit()\n  return {\n    status: !!submitSuccess\n    // true means submit success, RingCentral app will close integration window\n  }\n})\n\n// Open window with proper params so user can do authorization\n// in opened window by RingCentral, window.open would not work,\n// check src/index.ts for detail\napp.openWindow(windowUrl: string)\n```\n\n## Test\n\n```bash\nnpm i\nnpm run test\n```\n\n## Real world demo\n\n- [ringcentral-notification-app with UI(authorization and else)](https://github.com/ringcentral/ringcentral-notification-demo-ui-app)\n- [github-notification-app-demo](https://github.com/ringcentral/github-notification-app-demo)\n\n## Tools\n\n- [Developer tool to simulate running in RingCentral App](https://github.com/ringcentral/ringcentral-notification-app-developer-tool)\n\n## Framework\n\n- [https://github.com/ringcentral/notification-app-js](https://github.com/ringcentral/notification-app-js)\n\n## License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fringcentral%2Fringcentral-notification-app-helper","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fringcentral%2Fringcentral-notification-app-helper","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fringcentral%2Fringcentral-notification-app-helper/lists"}