Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@guanguans
guanguans committed Nov 14, 2022
1 parent baf216c commit 0d2258a
Show file tree
Hide file tree
Showing 3 changed files with 202 additions and 3 deletions.
101 changes: 100 additions & 1 deletion README-EN.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

[简体中文](README.md) | [ENGLISH](README-EN.md)

> Push notification sdk(Bark、Chanify、DingTalk、Discord、Email、FeiShu、Gitter、Google Chat、iGot、Logger、Mattermost、Now Push、PushBack、Push、PushDeer、Pushover、PushPlus、QQ Channel Bot、Rocket Chat、ServerChan、Showdoc Push、Slack、Telegram、Webhook、WeWork、XiZhi、Zulip).
> Push notification sdk(Bark、Chanify、DingTalk、Discord、Email、FeiShu、Gitter、Google Chat、iGot、Logger、Mattermost、Microsoft Teams、Now Push、PushBack、Push、PushDeer、Pushover、PushPlus、QQ Channel Bot、Rocket Chat、ServerChan、Showdoc Push、Slack、Telegram、Webhook、WeWork、XiZhi、Zulip).
[![Tests](https://github.com/guanguans/notify/workflows/Tests/badge.svg)](https://github.com/guanguans/notify/actions)
[![Check & fix styling](https://github.com/guanguans/notify/workflows/Check%20&%20fix%20styling/badge.svg)](https://github.com/guanguans/notify/actions)
Expand All @@ -29,6 +29,7 @@
* [iGot](http://hellyw.com/#/)
* [Logger](https://github.com/php-fig/log)
* [Mattermost](https://api.mattermost.com)
* [Microsoft Teams](https://www.microsoft.com/zh-cn/microsoft-teams/teams-for-work)
* [Now Push](https://nowpush.io/api-docs/)
* [PushBack](https://pushback.io/docs/getting-started)
* [Push](https://docs.push.techulus.com/api-documentation)
Expand Down Expand Up @@ -452,6 +453,104 @@ Factory::mattermost()
```
</details>

<details>
<summary><b>Microsoft Teams</b></summary>

```php
$microsoftTeamsMessage = new MicrosoftTeamsMessage([
'correlationId' => 'This is correlationId.',
'expectedActors' => [
'[email protected]',
],
'originator' => 'This is originator.',
'summary' => 'This is summary.',
'themeColor' => '0076D7',
'hideOriginalBody' => false,
'title' => 'This is title.',
'text' => 'This is text.',
'sections' => [],
'potentialAction' => [],
]);

$microsoftTeamsMessage
->addSection([
'title' => 'This is title.',
'startGroup' => true,
'activityImage' => 'This is activityImage.',
'activityTitle' => 'This is activityTitle.',
'activitySubtitle' => 'This is activitySubtitle.',
'activityText' => 'This is activityText.',
'heroImage' => 'This is heroImage.',
'text' => 'This is text.',
'facts' => [
[
'name' => 'This is name.',
'value' => 'This is value.',
],
],
'images' => [
'This is images.',
],
'potentialAction' => [],
])
->addPotentialAction([
'@type' => 'OpenUri',
'name' => 'This is name.',
'targets' => [
[
'os' => 'default',
'uri' => 'https://learn.microsoft.com/outlook/actionable-messages',
],
],
])
->addPotentialAction([
'@type' => 'HttpPOST',
'name' => 'This is name.',
'target' => 'https://learn.microsoft.com/outlook/actionable-messages',
'headers' => [
[
'name' => 'X-Version',
'value' => 'v1.0.0',
],
],
'body' => [
'field' => 'value',
],
'bodyContentType' => 'application/x-www-form-urlencoded',
])
->addPotentialAction([
'@type' => 'ActionCard',
'name' => 'This is name.',
'inputs' => [
[
'@type' => 'TextInput',
'id' => 'comment',
'isRequired' => true,
'title' => 'This is title.',
'value' => 'This is value.',
'isMultiline' => true,
],
],
'actions' => [],
])
->addPotentialAction([
'@type' => 'InvokeAddInCommand',
'name' => 'This is name.',
'addInId' => '527104a1-f1a5-475a-9199-7a968161c870',
'desktopCommandId' => 'show',
'initializationContext' => [
'property1' => 'This is property1.',
'property2' => 'This is property2.',
],
]);

Factory::microsoftTeams()
->setWebhookUrl('url')
->setMessage($microsoftTeamsMessage)
->send();
```
</details>

<details>
<summary><b>Now Push</b></summary>

Expand Down
101 changes: 100 additions & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

[简体中文](README.md) | [ENGLISH](README-EN.md)

> 推送通知 sdk(Bark、Chanify、钉钉群机器人、Discord、邮件、飞书群机器人、Gitter、Google Chat、iGot、Logger、Mattermost、Now Push、PushBack、Push、PushDeer、Pushover、PushPlus、QQ 频道机器人、Rocket Chat、Server 酱、Showdoc Push、Slack、Telegram、Webhook、企业微信群机器人、息知、Zulip)。
> 推送通知 sdk(Bark、Chanify、钉钉群机器人、Discord、邮件、飞书群机器人、Gitter、Google Chat、iGot、Logger、Mattermost、Microsoft Teams、Now Push、PushBack、Push、PushDeer、Pushover、PushPlus、QQ 频道机器人、Rocket Chat、Server 酱、Showdoc Push、Slack、Telegram、Webhook、企业微信群机器人、息知、Zulip)。
[![Tests](https://github.com/guanguans/notify/workflows/Tests/badge.svg)](https://github.com/guanguans/notify/actions)
[![Check & fix styling](https://github.com/guanguans/notify/workflows/Check%20&%20fix%20styling/badge.svg)](https://github.com/guanguans/notify/actions)
Expand All @@ -29,6 +29,7 @@
* [iGot](http://hellyw.com/#/)
* [Logger](https://github.com/php-fig/log)
* [Mattermost](https://api.mattermost.com)
* [Microsoft Teams](https://www.microsoft.com/zh-cn/microsoft-teams/teams-for-work)
* [Now Push](https://nowpush.io/api-docs/)
* [PushBack](https://pushback.io/docs/getting-started)
* [Push](https://docs.push.techulus.com/api-documentation)
Expand Down Expand Up @@ -452,6 +453,104 @@ Factory::mattermost()
```
</details>

<details>
<summary><b>Microsoft Teams</b></summary>

```php
$microsoftTeamsMessage = new MicrosoftTeamsMessage([
'correlationId' => 'This is correlationId.',
'expectedActors' => [
'[email protected]',
],
'originator' => 'This is originator.',
'summary' => 'This is summary.',
'themeColor' => '0076D7',
'hideOriginalBody' => false,
'title' => 'This is title.',
'text' => 'This is text.',
'sections' => [],
'potentialAction' => [],
]);

$microsoftTeamsMessage
->addSection([
'title' => 'This is title.',
'startGroup' => true,
'activityImage' => 'This is activityImage.',
'activityTitle' => 'This is activityTitle.',
'activitySubtitle' => 'This is activitySubtitle.',
'activityText' => 'This is activityText.',
'heroImage' => 'This is heroImage.',
'text' => 'This is text.',
'facts' => [
[
'name' => 'This is name.',
'value' => 'This is value.',
],
],
'images' => [
'This is images.',
],
'potentialAction' => [],
])
->addPotentialAction([
'@type' => 'OpenUri',
'name' => 'This is name.',
'targets' => [
[
'os' => 'default',
'uri' => 'https://learn.microsoft.com/outlook/actionable-messages',
],
],
])
->addPotentialAction([
'@type' => 'HttpPOST',
'name' => 'This is name.',
'target' => 'https://learn.microsoft.com/outlook/actionable-messages',
'headers' => [
[
'name' => 'X-Version',
'value' => 'v1.0.0',
],
],
'body' => [
'field' => 'value',
],
'bodyContentType' => 'application/x-www-form-urlencoded',
])
->addPotentialAction([
'@type' => 'ActionCard',
'name' => 'This is name.',
'inputs' => [
[
'@type' => 'TextInput',
'id' => 'comment',
'isRequired' => true,
'title' => 'This is title.',
'value' => 'This is value.',
'isMultiline' => true,
],
],
'actions' => [],
])
->addPotentialAction([
'@type' => 'InvokeAddInCommand',
'name' => 'This is name.',
'addInId' => '527104a1-f1a5-475a-9199-7a968161c870',
'desktopCommandId' => 'show',
'initializationContext' => [
'property1' => 'This is property1.',
'property2' => 'This is property2.',
],
]);

Factory::microsoftTeams()
->setWebhookUrl('url')
->setMessage($microsoftTeamsMessage)
->send();
```
</details>

<details>
<summary><b>Now Push</b></summary>

Expand Down
3 changes: 2 additions & 1 deletion composer.json
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "guanguans/notify",
"description": "推送通知 sdk(Bark、Chanify、钉钉群机器人、Discord、邮件、飞书群机器人、Gitter、Google Chat、iGot、Logger、Mattermost、Now Push、PushBack、Push、PushDeer、PushPlus、QQ 频道机器人、Rocket Chat、Server 酱、Showdoc Push、Slack、Telegram、Webhook、企业微信群机器人、息知、Zulip)。",
"description": "推送通知 sdk(Bark、Chanify、钉钉群机器人、Discord、邮件、飞书群机器人、Gitter、Google Chat、iGot、Logger、Mattermost、Microsoft Teams、Now Push、PushBack、Push、PushDeer、PushPlus、QQ 频道机器人、Rocket Chat、Server 酱、Showdoc Push、Slack、Telegram、Webhook、企业微信群机器人、息知、Zulip)。",
"license": "MIT",
"type": "library",
"keywords": [
Expand All @@ -20,6 +20,7 @@
"iGot",
"logger",
"mattermost",
"microsoft teams",
"now push",
"pushBack",
"push",
Expand Down

0 comments on commit 0d2258a

Please sign in to comment.