Skip to content

Latest commit

 

History

History
139 lines (109 loc) · 3.46 KB

File metadata and controls

139 lines (109 loc) · 3.46 KB
layout default
menu_item api
title IndexReucEntry
description Version 0.26.1
return_to
API Documentation Index
/api/
sections
add clear entryCount find getByIndex getByPath remove Instance Variables
#add
#clear
#entryCount
#find
#getByIndex
#getByPath
#remove
#ivars

IndexReucEntry.add AsyncExperimental

IndexReucEntry.add(index, path, ancestor_mode, ancestor_id, our_mode, our_id, their_mode, their_id).then(function(result) {
  // Use result
});
Parameters Type
index Index
path String
ancestor_mode Number
ancestor_id Oid
our_mode Number
our_id Oid
their_mode Number
their_id Oid
Returns
Number

IndexReucEntry.clear AsyncExperimental

IndexReucEntry.clear(index).then(function() {
  // method complete});
Parameters Type
index Index

IndexReucEntry.entryCount SyncExperimental

var result = IndexReucEntry.entryCount(index);
Parameters Type
index Index
Returns
Number

IndexReucEntry.find AsyncExperimental

IndexReucEntry.find(index, path).then(function(result) {
  // Use result
});
Parameters Type
index Index
path String
Returns
Number

IndexReucEntry.getByIndex SyncExperimental

var indexReucEntry = IndexReucEntry.getByIndex(index, n);
Parameters Type
index Index
n Number
Returns
IndexReucEntry

IndexReucEntry.getByPath SyncExperimental

var indexReucEntry = IndexReucEntry.getByPath(index, path);
Parameters Type
index Index
path String
Returns
IndexReucEntry

IndexReucEntry.remove AsyncExperimental

IndexReucEntry.remove(index, n).then(function(result) {
  // Use result
});
Parameters Type
index Index
n Number
Returns
Number

Instance Variables

Variable Type Description
mode Number
oid Oid
path String