Overview

Namespaces

  • LoginRadiusSDK
    • Advance
    • Clients
    • CustomerRegistration
      • Account
      • Authentication
      • Social
    • Utility

Classes

  • AccountAPI
  • CustomObjectAPI
  • CustomRegistrationDataAPI
  • RoleAPI
  • Overview
  • Namespace
  • Class

Class CustomObjectAPI

Class CustomObjectAPI

This is the main class to communicate with LoginRadius Custom Object APIs.

Namespace: LoginRadiusSDK\CustomerRegistration\Account
Located at LoginRadiusSDK/CustomerRegistration/Account/CustomObjectAPI.php
Methods summary
public
# __construct( type $apikey = '', type $apisecret = '', type $options = array() )

Parameters

$apikey
$apisecret
$options
public type
# insert( $uid, $object_name, $data, $fields = '*' )

This API is used to create custom objects.

This API is used to create custom objects.

Parameters

$uid
the identifier for each user account
$object_name
Custom Object name
$data
$fields

Returns

type
public type
# getObjectByAccountid( $uid, $object_name, $fields = '*' )

This API is used to retrieve the Custom Object for the specified account based on the account ID(UID).

This API is used to retrieve the Custom Object for the specified account based on the account ID(UID).

Parameters

$uid
the identifier for each user account
$object_name
Custom Object name
$fields

Returns

type
public type
# updateObjectByRecordID( $uid, $object_name, $object_record_id, $update_type, $data, $fields = '*' )

This API is used to update the Custom Object for the specified account based on the record ID($object_record_id).

This API is used to update the Custom Object for the specified account based on the record ID($object_record_id).

Parameters

$uid
the identifier for each user account
$object_name
Custom Object name
$object_record_id
of the user's record in Custom Object
$update_type
$data

"Store my field1 value", "field2": "Store my field2 value" }';

$fields

Returns

type
public type
# getObjectByRecordID( $uid, $object_name, $object_record_id, $fields = '*' )

This API is used to retrieve the Custom Object for the specified account based on the record ID($object_record_id).

This API is used to retrieve the Custom Object for the specified account based on the record ID($object_record_id).

Parameters

$uid
the identifier for each user account
$object_name
Custom Object name
$object_record_id
of the user's record in Custom Object
$fields

Returns

type
public type
# delete( $uid, $object_name, $object_record_id, $fields = '*' )

This API is used to remove the specified Custom Object based on the account ID(UID).

This API is used to remove the specified Custom Object based on the account ID(UID).

Parameters

$uid
the identifier for each user account
$object_name
Custom Object name
$object_record_id
of the user's record in Custom Object
$fields

Returns

type
API documentation generated by ApiGen