Skip to content

Latest commit

 

History

History
162 lines (105 loc) · 5.2 KB

CHANGELOG.md

File metadata and controls

162 lines (105 loc) · 5.2 KB

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

Unreleased

0.5.8 - 2018-08-21

Added

  • addUsersToRoom and removeUsersFromRoom functionality added. #29 by @mludi

0.5.7 - 2018-08-14

Added

  • joinRoom functionality added. #27 by @mludi

0.5.6 - 2018-07-30

Fixed

  • getUsersByIds and getUsers now properly set query parameters

0.5.5 - 2018-07-30

Added

0.5.4 - 2018-06-25

Added

0.5.3 - 2018-06-11

Added

0.5.2 - 2018-06-07

Fixed

Added

0.5.1 - 2018-05-25

Changed

  • User ID is validated to be a string as part of createUser, authenticate, and generateAccessToken calls

Fixed

  • getUserRooms no longer crashes if joinable option not set

0.5.0 - 2018-05-11

Changed

  • API calls to Chatkit servers now return an associative array that has the keys 'status' and 'body'.

0.4.0 - 2018-04-20

Added

  • authenticate has been added. This should be the function you use to authenticate your users for Chatkit.

You need to provide an associative array that has a user_id key with a string value. For example:

$chatkit->authenticate([ 'user_id' => 'ham' ]);

It returns an associative array that is structured like this:

[
    'status' => 200,
    'headers' => [
        'Some-Header' => 'some-value'
    ],
    'body' => [
        'access_token' => 'an.access.token',
        'token_type' => 'bearer',
        'expires_in' => 86400
    ]
]

where:

  • status is the suggested HTTP response status code,
  • headers are the suggested response headers,
  • body holds the token payload.

Removed

  • getTokenPair has been removed

Changed

  • Authentication no longer returns refresh tokens.

If your client devices are running the:

  • Swift SDK - (breaking change) you must be using version >= 0.8.0 of chatkit-swift.
  • Android SDK - you won't be affected regardless of which version you are running.
  • JS SDK - you won't be affected regardless of which version you are running.
  • (Nearly) all functions now take an object (an associative array) as their sole parameter. As examples:
  • Constructing a Chatkit object is done like this:
$chatkit = new Chatkit\Chatkit([
    'instance_locator' => 'your:instance:locator',
    'key' => 'your:key'
]);
  • createUser is now called like this:
$chatkit->createUser([
    'id' => 'dr_php',
    'name' => 'Dr PHP',
    'avatar_url' => 'https://placekitten.com/400/500',
    'custom_data' => [
        'a' => 'piece of data'
    ]
]);
  • authenticate (previously getTokenPair) is now called like this:
$chatkit->authenticate([
    'user_id' => 'dr_php'
]);
  • createRoom is now called like this:
$chatkit->createRoom([
    'creator_id' => 'dr_php',
    'name' => 'A room with a name',
    'private' => false
]);