Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/happones/nativescript-laravel-echo
A nativescript plugin for laravel-echo
https://github.com/happones/nativescript-laravel-echo
laravel-echo nativescript nativescript-plugin pusher socket-io
Last synced: 22 days ago
JSON representation
A nativescript plugin for laravel-echo
- Host: GitHub
- URL: https://github.com/happones/nativescript-laravel-echo
- Owner: happones
- License: apache-2.0
- Created: 2018-07-20T20:55:21.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2019-09-11T15:06:46.000Z (over 5 years ago)
- Last Synced: 2024-10-10T23:32:55.811Z (2 months ago)
- Topics: laravel-echo, nativescript, nativescript-plugin, pusher, socket-io
- Language: TypeScript
- Size: 2.04 MB
- Stars: 10
- Watchers: 5
- Forks: 2
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# NativeScript Laravel-Echo
[](https://www.npmjs.com/package/nativescript-laravel-echo)
[](https://www.npmjs.com/package/nativescript-laravel-echo)
[](https://npmjs.org/package/nativescript-laravel-echo)
This is a [laravel-echo](https://github.com/laravel/echo/blob/master/src/channel/pusher-channel.ts) plugin for native applications made with nativescript
For more information read [Laravel Broadcast](https://laravel.com/docs/master/broadcasting).
## Prerequisites / Requirements
Necesary api authentication in your laravel backend application.
**Modify the file where the following line `Broadcast::routes()`**
Example in `app/Providers/BroadcastServiceProvider.php`
```php
class BroadcastServiceProvider extends ServiceProvider
{
/**
* Bootstrap any application services.
*
* @return void
*/
public function boot()
{
Broadcast::routes(['middleware' => 'auth:api']);
require base_path('routes/channels.php');
}
}
```
## Installation
Describe your plugin installation steps. Ideally it would be something like:
`$ tns plugin add nativescript-laravel-echo`
## Usage
```php
namespace App\Events;
use Illuminate\Broadcasting\Channel;
use Illuminate\Queue\SerializesModels;
use Illuminate\Broadcasting\PrivateChannel;
use Illuminate\Broadcasting\PresenceChannel;
use Illuminate\Broadcasting\InteractsWithSockets;
use Illuminate\Contracts\Broadcasting\ShouldBroadcast;
class Event implements ShouldBroadcast
{
/**
* Information about the shipping status update.
*
* @var string
*/
public $data; //data show in console.dir as data
}
```
**Javascript**
```javascript
const TnsEcho = require('nativescript-laravel-echo').TnsEcho;
const token = 'Asdsd3dsdsTytf';//Your token
const options = {
//....
broadcaster: 'socket.io',// pusher,
headers: {
auth: {
bearer: `Bearer ${token}`
}
}
}
const Echo = new TnsEcho(options)
Echo.channel('YourChannel').listen('Event', e => {
console.dir(e)
})
//presence channel for others
const http = require('tns-core-modules/http');
http.request({
//....
headers: {
//...
'X-Socket-Id': Echo.socketId() // get socket id
}
});
```
**TypeScript**
```typescript
import { TnsEcho } from 'nativescript-laravel-echo';
const token = 'Asdsd3dsdsTytf';//Your token
const options = {
//....
broadcaster: 'socket.io',// pusher,
headers: {
auth: {
bearer: `Bearer ${token}`
}
}
}
this.Echo = new TnsEcho(options)
this.Echo.channel('YourChannel').listen('Event', e => {
console.dir(e)
})
//presence channel for others
import * as http from 'tns-core-modules/http';
http.request({
//....
headers: {
//...
'X-Socket-Id': this.Echo.socketId() // get socket id
}
})
```
## Options
These are each of the parameters that can go in the object options.
| Property | Default | Description |
| --- | --- | --- |
| broadcaster | pusher | Driver for broadcast pusher or socket.io |
| host | null | Your host only socket.io |
| authEndpoint | /broadcasting/auth | Your auth endpoint only for Pusher |
| key | null | Your api key of Pusher App |
| cluster | null | Your cluster of Pusher App |
| auth | auth:{headers:{}} | Necesary in private an presence channel's with Authorization header |
| namespace | App.Events | The namespace backend events |
| debug | false | Enable debug only socket.io broadcaster |
| forceWebsockets | false | Force WebSockets |
## License
Apache License Version 2.0, January 2004