ChatKittyPlatformAPI.Api.Imports (chatkitty_platform_sdk v0.1.0)

API calls for all endpoints tagged Imports.

Link to this section Summary

Functions

Import channel members Batch imports channel members from a JSON array file

Import channels Batch imports channels from a JSON array file

Import messages Batch imports messages from a JSON array file

Import users Batch imports users from a JSON array file

Link to this section Functions

Link to this function

import_channel_members(connection, id, file, opts \\ [])

Import channel members Batch imports channel members from a JSON array file

parameters

Parameters

  • connection (ChatKittyPlatformAPI.Connection): Connection to server
  • id (integer()):
  • file (String.t): JSON array file with user references to be added as members
  • opts (KeywordList): [optional] Optional parameters

returns

Returns

on success {:error, Tesla.Env.t} on failure

Link to this function

import_channels(connection, file, opts \\ [])

Import channels Batch imports channels from a JSON array file

parameters

Parameters

  • connection (ChatKittyPlatformAPI.Connection): Connection to server
  • file (String.t): JSON array file with channels
  • opts (KeywordList): [optional] Optional parameters

returns

Returns

on success {:error, Tesla.Env.t} on failure

Link to this function

import_messages(connection, file, opts \\ [])

Import messages Batch imports messages from a JSON array file

parameters

Parameters

  • connection (ChatKittyPlatformAPI.Connection): Connection to server
  • file (String.t): JSON array file with messages
  • opts (KeywordList): [optional] Optional parameters

returns

Returns

on success {:error, Tesla.Env.t} on failure

Link to this function

import_users(connection, file, opts \\ [])

Import users Batch imports users from a JSON array file

parameters

Parameters

  • connection (ChatKittyPlatformAPI.Connection): Connection to server
  • file (String.t): JSON array file with users
  • opts (KeywordList): [optional] Optional parameters

returns

Returns

on success {:error, Tesla.Env.t} on failure