Package com.ringcentral.paths.teammessaging.v1.dataexport

Class Index

java.lang.Object

com.ringcentral.paths.teammessaging.v1.dataexport.Index

public class Index
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
Index	parent
RestClient	rc
String	taskId

Constructor Summary

Constructors

Constructor	Description
Index(Index parent, String taskId)

Method Summary

Modifier and Type	Method	Description
DataExportTask	get()	Returns the links for downloading Glip data exported within the specified task.
DataExportTaskList	list()
DataExportTaskList	list(ListDataExportTasksNewParameters queryParams)	Returns the list of Glip data export tasks.
String	path()
String	path(Boolean withParameter)
DataExportTask	post(CreateDataExportTaskRequest createDataExportTaskRequest)	Creates a task for Glip data export and returns a link at which the exported data will be available in future once the task is implemented.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

rc

public RestClient rc

parent

public Index parent

taskId

public String taskId

Constructor Details

Index

public Index(Index parent,
 String taskId)

Method Details

path

public String path(Boolean withParameter)

path

public String path()

list

public DataExportTaskList list(ListDataExportTasksNewParameters queryParams)
                        throws RestException,
IOException

Returns the list of Glip data export tasks. HTTP Method: get Endpoint: /team-messaging/v1/data-export Rate Limit Group: Medium App Permission: TeamMessaging User Permission: Glip

Throws:

RestException

IOException

list

public DataExportTaskList list()
                        throws RestException,
IOException

Throws:

RestException

IOException

post

public DataExportTask post(CreateDataExportTaskRequest createDataExportTaskRequest)
                    throws RestException,
IOException

Creates a task for Glip data export and returns a link at which the exported data will be available in future once the task is implemented. The exported data can be downloaded by calling Get Data Export Task method with the specified task ID. Simultaneously no more than 2 tasks per company can be created. HTTP Method: post Endpoint: /team-messaging/v1/data-export Rate Limit Group: Heavy App Permission: TeamMessaging User Permission: Glip

Throws:

RestException

IOException

get

public DataExportTask get()
                   throws RestException,
IOException

Returns the links for downloading Glip data exported within the specified task. If the export task is still in progress, then only the task status will be returned. If the data is ready for downloading, then the list of URLs will be returned. HTTP Method: get Endpoint: /team-messaging/v1/data-export/{taskId} Rate Limit Group: Medium App Permission: TeamMessaging User Permission: Glip

Throws:

RestException

IOException