# VmosoApi.ObjectApi

All URIs are relative to *https://www.vmoso.com/svc*

Method | HTTP request | Description
------------- | ------------- | -------------
[**changeOwner**](ObjectApi.md#changeOwner) | **PUT** /changeOwner/{objectKey}/{userKey} | 
[**changeOwnerObsolete**](ObjectApi.md#changeOwnerObsolete) | **PUT** /changeOnwer/{objectKey}/{userKey} | 
[**clearAllForList**](ObjectApi.md#clearAllForList) | **POST** /objects/read/clearAll | 
[**getAssignmentReadState**](ObjectApi.md#getAssignmentReadState) | **GET** /assignment/readState | 
[**getFollowers**](ObjectApi.md#getFollowers) | **GET** /{objectKey}/followers | 
[**getObjectReaders**](ObjectApi.md#getObjectReaders) | **GET** /objects/read/getReaderList | 
[**markAllTilesRead**](ObjectApi.md#markAllTilesRead) | **POST** /objects/read/{key}/markAllTilesRead | 
[**markTilesRead**](ObjectApi.md#markTilesRead) | **POST** /objects/read/markTilesRead | 
[**searchAutocomplete**](ObjectApi.md#searchAutocomplete) | **GET** /search/autocomplete | 
[**searchObjects**](ObjectApi.md#searchObjects) | **GET** /search/objectpicker | 
[**setActionNewTime**](ObjectApi.md#setActionNewTime) | **POST** /new/setActionNewTime | 
[**setActionNewTimeForList**](ObjectApi.md#setActionNewTimeForList) | **POST** /new/setActionNewTimeForList | 
[**updateReadInfo**](ObjectApi.md#updateReadInfo) | **POST** /objects/read/updateReadInfo | 
[**updateReadInfoByEmail**](ObjectApi.md#updateReadInfoByEmail) | **GET** /objects/read/updateReadInfoByEmail | 


<a name="changeOwner"></a>
# **changeOwner**
> ChangeOwnerResult changeOwner(objectKey, userKey)



Use this API to change the owner of an object.

### Example
```javascript
var VmosoApi = require('vmoso-api');
var defaultClient = VmosoApi.ApiClient.default;

// Configure API key authorization: vmoso_auth
var vmoso_auth = defaultClient.authentications['vmoso_auth'];
vmoso_auth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//vmoso_auth.apiKeyPrefix['X-CV-Authorization'] = "Token"

var apiInstance = new VmosoApi.ObjectApi()

var objectKey = "objectKey_example"; // {String} Object ID.

var userKey = "userKey_example"; // {String} New owner.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.changeOwner(objectKey, userKey, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **objectKey** | **String**| Object ID. | 
 **userKey** | **String**| New owner. | 

### Return type

[**ChangeOwnerResult**](ChangeOwnerResult.md)

### Authorization

[vmoso_auth](../README.md#vmoso_auth)

### HTTP reuqest headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

<a name="changeOwnerObsolete"></a>
# **changeOwnerObsolete**
> ChangeOwnerObsoleteResult changeOwnerObsolete(objectKey, userKey)



Use this API to change the owner of an object.

### Example
```javascript
var VmosoApi = require('vmoso-api');
var defaultClient = VmosoApi.ApiClient.default;

// Configure API key authorization: vmoso_auth
var vmoso_auth = defaultClient.authentications['vmoso_auth'];
vmoso_auth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//vmoso_auth.apiKeyPrefix['X-CV-Authorization'] = "Token"

var apiInstance = new VmosoApi.ObjectApi()

var objectKey = "objectKey_example"; // {String} Object ID.

var userKey = "userKey_example"; // {String} User ID.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.changeOwnerObsolete(objectKey, userKey, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **objectKey** | **String**| Object ID. | 
 **userKey** | **String**| User ID. | 

### Return type

[**ChangeOwnerObsoleteResult**](ChangeOwnerObsoleteResult.md)

### Authorization

[vmoso_auth](../README.md#vmoso_auth)

### HTTP reuqest headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

<a name="clearAllForList"></a>
# **clearAllForList**
> ClearAllForListResult clearAllForList(input)



Use this API to clear a list of objects.

### Example
```javascript
var VmosoApi = require('vmoso-api');
var defaultClient = VmosoApi.ApiClient.default;

// Configure API key authorization: vmoso_auth
var vmoso_auth = defaultClient.authentications['vmoso_auth'];
vmoso_auth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//vmoso_auth.apiKeyPrefix['X-CV-Authorization'] = "Token"

var apiInstance = new VmosoApi.ObjectApi()

var input = new VmosoApi.ClearAllForListInput(); // {ClearAllForListInput} Query to select list.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.clearAllForList(input, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **input** | [**ClearAllForListInput**](ClearAllForListInput.md)| Query to select list. | 

### Return type

[**ClearAllForListResult**](ClearAllForListResult.md)

### Authorization

[vmoso_auth](../README.md#vmoso_auth)

### HTTP reuqest headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

<a name="getAssignmentReadState"></a>
# **getAssignmentReadState**
> GetAssignmentReadStateResult getAssignmentReadState(objectKey)



Use this API to get the read state of an assignment.

### Example
```javascript
var VmosoApi = require('vmoso-api');
var defaultClient = VmosoApi.ApiClient.default;

// Configure API key authorization: vmoso_auth
var vmoso_auth = defaultClient.authentications['vmoso_auth'];
vmoso_auth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//vmoso_auth.apiKeyPrefix['X-CV-Authorization'] = "Token"

var apiInstance = new VmosoApi.ObjectApi()

var objectKey = "objectKey_example"; // {String} Object ID.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAssignmentReadState(objectKey, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **objectKey** | **String**| Object ID. | 

### Return type

[**GetAssignmentReadStateResult**](GetAssignmentReadStateResult.md)

### Authorization

[vmoso_auth](../README.md#vmoso_auth)

### HTTP reuqest headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

<a name="getFollowers"></a>
# **getFollowers**
> GetFollowersResult getFollowers(objectKey, pg)



Use this API to get the followers for an object.

### Example
```javascript
var VmosoApi = require('vmoso-api');
var defaultClient = VmosoApi.ApiClient.default;

// Configure API key authorization: vmoso_auth
var vmoso_auth = defaultClient.authentications['vmoso_auth'];
vmoso_auth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//vmoso_auth.apiKeyPrefix['X-CV-Authorization'] = "Token"

var apiInstance = new VmosoApi.ObjectApi()

var objectKey = "objectKey_example"; // {String} Object ID.

var pg = "pg_example"; // {String} Pagination options.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getFollowers(objectKey, pg, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **objectKey** | **String**| Object ID. | 
 **pg** | **String**| Pagination options. | 

### Return type

[**GetFollowersResult**](GetFollowersResult.md)

### Authorization

[vmoso_auth](../README.md#vmoso_auth)

### HTTP reuqest headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

<a name="getObjectReaders"></a>
# **getObjectReaders**
> GetObjectReadersResult getObjectReaders(objectKey, opts)



Use this API to get the object readers.

### Example
```javascript
var VmosoApi = require('vmoso-api');
var defaultClient = VmosoApi.ApiClient.default;

// Configure API key authorization: vmoso_auth
var vmoso_auth = defaultClient.authentications['vmoso_auth'];
vmoso_auth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//vmoso_auth.apiKeyPrefix['X-CV-Authorization'] = "Token"

var apiInstance = new VmosoApi.ObjectApi()

var objectKey = "objectKey_example"; // {String} Object ID.

var opts = { 
  'options': "options_example", // {String} Reader list options based on ReaderListOptionsV2Record.
  'pg': "pg_example" // {String} Pagination options.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getObjectReaders(objectKey, opts, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **objectKey** | **String**| Object ID. | 
 **options** | **String**| Reader list options based on ReaderListOptionsV2Record. | [optional] 
 **pg** | **String**| Pagination options. | [optional] 

### Return type

[**GetObjectReadersResult**](GetObjectReadersResult.md)

### Authorization

[vmoso_auth](../README.md#vmoso_auth)

### HTTP reuqest headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

<a name="markAllTilesRead"></a>
# **markAllTilesRead**
> MarkAllTilesReadResult markAllTilesRead(key)



Use this API to mark all tiles for an object as read.

### Example
```javascript
var VmosoApi = require('vmoso-api');
var defaultClient = VmosoApi.ApiClient.default;

// Configure API key authorization: vmoso_auth
var vmoso_auth = defaultClient.authentications['vmoso_auth'];
vmoso_auth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//vmoso_auth.apiKeyPrefix['X-CV-Authorization'] = "Token"

var apiInstance = new VmosoApi.ObjectApi()

var key = "key_example"; // {String} Object ID.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.markAllTilesRead(key, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **key** | **String**| Object ID. | 

### Return type

[**MarkAllTilesReadResult**](MarkAllTilesReadResult.md)

### Authorization

[vmoso_auth](../README.md#vmoso_auth)

### HTTP reuqest headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

<a name="markTilesRead"></a>
# **markTilesRead**
> MarkTilesReadResult markTilesRead(input)



Use this API to mark some tiles for an object as read.

### Example
```javascript
var VmosoApi = require('vmoso-api');
var defaultClient = VmosoApi.ApiClient.default;

// Configure API key authorization: vmoso_auth
var vmoso_auth = defaultClient.authentications['vmoso_auth'];
vmoso_auth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//vmoso_auth.apiKeyPrefix['X-CV-Authorization'] = "Token"

var apiInstance = new VmosoApi.ObjectApi()

var input = new VmosoApi.MarkTilesReadInput(); // {MarkTilesReadInput} Objects to mark as read.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.markTilesRead(input, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **input** | [**MarkTilesReadInput**](MarkTilesReadInput.md)| Objects to mark as read. | 

### Return type

[**MarkTilesReadResult**](MarkTilesReadResult.md)

### Authorization

[vmoso_auth](../README.md#vmoso_auth)

### HTTP reuqest headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

<a name="searchAutocomplete"></a>
# **searchAutocomplete**
> SearchAutocompleteResult searchAutocomplete(options, pg)



Use this API for searches where you use autocomplete to show possible matches.

### Example
```javascript
var VmosoApi = require('vmoso-api');
var defaultClient = VmosoApi.ApiClient.default;

// Configure API key authorization: vmoso_auth
var vmoso_auth = defaultClient.authentications['vmoso_auth'];
vmoso_auth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//vmoso_auth.apiKeyPrefix['X-CV-Authorization'] = "Token"

var apiInstance = new VmosoApi.ObjectApi()

var options = "options_example"; // {String} Search criteria.

var pg = "pg_example"; // {String} Pagination preferences for search results.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.searchAutocomplete(options, pg, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **options** | **String**| Search criteria. | 
 **pg** | **String**| Pagination preferences for search results. | 

### Return type

[**SearchAutocompleteResult**](SearchAutocompleteResult.md)

### Authorization

[vmoso_auth](../README.md#vmoso_auth)

### HTTP reuqest headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

<a name="searchObjects"></a>
# **searchObjects**
> SearchObjectsResult searchObjects(options, pg)



Use this API to conduct a keyword search.

### Example
```javascript
var VmosoApi = require('vmoso-api');
var defaultClient = VmosoApi.ApiClient.default;

// Configure API key authorization: vmoso_auth
var vmoso_auth = defaultClient.authentications['vmoso_auth'];
vmoso_auth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//vmoso_auth.apiKeyPrefix['X-CV-Authorization'] = "Token"

var apiInstance = new VmosoApi.ObjectApi()

var options = "options_example"; // {String} Search criteria.

var pg = "pg_example"; // {String} Pagination preferences for search results.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.searchObjects(options, pg, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **options** | **String**| Search criteria. | 
 **pg** | **String**| Pagination preferences for search results. | 

### Return type

[**SearchObjectsResult**](SearchObjectsResult.md)

### Authorization

[vmoso_auth](../README.md#vmoso_auth)

### HTTP reuqest headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

<a name="setActionNewTime"></a>
# **setActionNewTime**
> SetActionNewTimeResult setActionNewTime(input)



Use this API to set the new time for an action.

### Example
```javascript
var VmosoApi = require('vmoso-api');
var defaultClient = VmosoApi.ApiClient.default;

// Configure API key authorization: vmoso_auth
var vmoso_auth = defaultClient.authentications['vmoso_auth'];
vmoso_auth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//vmoso_auth.apiKeyPrefix['X-CV-Authorization'] = "Token"

var apiInstance = new VmosoApi.ObjectApi()

var input = new VmosoApi.SetActionNewTimeInput(); // {SetActionNewTimeInput} Object ID.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.setActionNewTime(input, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **input** | [**SetActionNewTimeInput**](SetActionNewTimeInput.md)| Object ID. | 

### Return type

[**SetActionNewTimeResult**](SetActionNewTimeResult.md)

### Authorization

[vmoso_auth](../README.md#vmoso_auth)

### HTTP reuqest headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

<a name="setActionNewTimeForList"></a>
# **setActionNewTimeForList**
> SetActionNewTimeForListResult setActionNewTimeForList(input)



Use this API to set the new time for a list.

### Example
```javascript
var VmosoApi = require('vmoso-api');
var defaultClient = VmosoApi.ApiClient.default;

// Configure API key authorization: vmoso_auth
var vmoso_auth = defaultClient.authentications['vmoso_auth'];
vmoso_auth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//vmoso_auth.apiKeyPrefix['X-CV-Authorization'] = "Token"

var apiInstance = new VmosoApi.ObjectApi()

var input = new VmosoApi.SetActionNewTimeForListInput(); // {SetActionNewTimeForListInput} Query to select list.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.setActionNewTimeForList(input, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **input** | [**SetActionNewTimeForListInput**](SetActionNewTimeForListInput.md)| Query to select list. | 

### Return type

[**SetActionNewTimeForListResult**](SetActionNewTimeForListResult.md)

### Authorization

[vmoso_auth](../README.md#vmoso_auth)

### HTTP reuqest headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

<a name="updateReadInfo"></a>
# **updateReadInfo**
> UpdateReadInfoResult updateReadInfo(input)



Use this API to update the read information for an object, such as a chat comment.

### Example
```javascript
var VmosoApi = require('vmoso-api');
var defaultClient = VmosoApi.ApiClient.default;

// Configure API key authorization: vmoso_auth
var vmoso_auth = defaultClient.authentications['vmoso_auth'];
vmoso_auth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//vmoso_auth.apiKeyPrefix['X-CV-Authorization'] = "Token"

var apiInstance = new VmosoApi.ObjectApi()

var input = new VmosoApi.UpdateReadInfoInput(); // {UpdateReadInfoInput} Objects to mark as read.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateReadInfo(input, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **input** | [**UpdateReadInfoInput**](UpdateReadInfoInput.md)| Objects to mark as read. | 

### Return type

[**UpdateReadInfoResult**](UpdateReadInfoResult.md)

### Authorization

[vmoso_auth](../README.md#vmoso_auth)

### HTTP reuqest headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

<a name="updateReadInfoByEmail"></a>
# **updateReadInfoByEmail**
> UpdateReadInfoByEmailResult updateReadInfoByEmail(userKey, id, objectKey)



Use this API to update the read information by email.

### Example
```javascript
var VmosoApi = require('vmoso-api');
var defaultClient = VmosoApi.ApiClient.default;

// Configure API key authorization: vmoso_auth
var vmoso_auth = defaultClient.authentications['vmoso_auth'];
vmoso_auth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//vmoso_auth.apiKeyPrefix['X-CV-Authorization'] = "Token"

var apiInstance = new VmosoApi.ObjectApi()

var userKey = "userKey_example"; // {String} User ID.

var id = "id_example"; // {String} Activity ID.

var objectKey = "objectKey_example"; // {String} Object ID.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateReadInfoByEmail(userKey, id, objectKey, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **userKey** | **String**| User ID. | 
 **id** | **String**| Activity ID. | 
 **objectKey** | **String**| Object ID. | 

### Return type

[**UpdateReadInfoByEmailResult**](UpdateReadInfoByEmailResult.md)

### Authorization

[vmoso_auth](../README.md#vmoso_auth)

### HTTP reuqest headers

 - **Content-Type**: Not defined
 - **Accept**: application/json