Pigeonhole Dark SDK

Latest Stable Version build codecov MIT license

Installation

  1. add pigeonholelive_sdk to your pubspec.yaml
dependencies:
  pigeonholelive_sdk: ^1.0.0
  1. run pub get

Usage

Create auth using OAuth access token or Workspace token, refer to Authentication for more info

import 'package:pigeonholelive_sdk/pigeonholelive_sdk.dart';

var pigeonholeLive = PigeonholeLive(
  auth: WorkspaceToken(token: 'xxx')
);

var pigeonholeLive = PigeonholeLive(
  auth: OAuthAccessToken(token: 'xxx')
);

Responses

For your convenient, the module will return response with related models

import 'package:pigeonholelive_sdk/pigeonholelive_sdk.dart';

var pigeonholes = await pigeonholeLive.pigeonhole.list();

print(pigeonholes.data?.first.passcode); // ABC123

Pagination

PaginationResult class will return Function() nextPage

import 'package:pigeonholelive_sdk/pigeonholelive_sdk.dart';

var pigeonholes = await pigeonholeLive.pigeonhole.list();

try {
  var nextPagePigeonholes = await pigeonholes.nextPage();
} on NoNextPageException catch (error) {
  // this exeception will be thrown if there's no next page
}

Available Modules

pigeonholeLive.attendee
pigeonholeLive.customBranding
pigeonholeLive.pigeonhole
pigeonholeLive.registrant
pigeonholeLive.session
pigeonholeLive.speaker
pigeonholeLive.subscription
pigeonholeLive.workspace

Documentation

Kindly visit Pigeonholelive Docs for more usage

License

This library is released under the MIT License

Libraries

pigeonhole_sdk