Discuss this help topic in SecureBlackbox Forum

TElGoogleDataStorage.List

TElGoogleDataStorage     


Filter: C#/Java  VB.NET  Pascal  C++  PHP  


Lists the objects in the storage.

Declaration

[C#/Java]
    void List(TElDataStorageObjectList Objects);
    void List(string Query, bool ShowFolders, bool ShowDeleted, TSBGoogleEntryOrder OrderBy, TElDataStorageObjectList Objects);
    void List(TElGoogleDataStorageObject Folder, TElGoogleDataStorageObject Objects);
    void List(TElGoogleDataStorageObject Folder, string Query, bool ShowFolders, bool ShowDeleted, TSBGoogleEntryOrder OrderBy, TElDataStorageObjectList Objects);
    void List(string Query, string Alt, string Author, long StartIndex, long MaxResults, DateTime UpdatedMin, DateTime UpdatedMax, string Category, string Title, bool ExactTitle, DateTime OpenedMin, DateTime OpenedMax, string Owner, string Writer, string Reader, bool ShowFolders, bool ShowDeleted, TSBGoogleEntryOrder OrderBy, TElDataStorageObjectList Objects);
    void List(TElGoogleDataStorageObject Folder, string Query, string Alt, string Author, long StartIndex, long MaxResults, DateTime UpdatedMin, DateTime UpdatedMax, string Category, string Title, bool ExactTitle, DateTime OpenedMin, DateTime OpenedMax, string Owner, string Writer, string Reader, bool ShowFolders, bool ShowDeleted, TSBGoogleEntryOrder OrderBy, TElDataStorageObjectList Objects);
    StringArray List();
    StringArray List(TElGoogleDataStorageObject Folder, string Query, string Alt, string Author, long StartIndex, long MaxResults, DateTime UpdatedMin, DateTime UpdatedMax, string Category, string Title, bool ExactTitle, DateTime OpenedMin, DateTime OpenedMax, string Owner, string Writer, string Reader, bool ShowFolders, bool ShowDeleted, TSBGoogleEntryOrder OrderBy);

[VB.NET]
    Sub List(ByVal Objects As TElDataStorageObjectList)
    Sub List(ByVal Query As String, ByVal ShowFolders As Boolean, ByVal ShowDeleted As Boolean, ByVal OrderBy As TSBGoogleEntryOrder, ByVal Objects As TElDataStorageObjectList)
    Sub List(ByVal Folder As TElGoogleDataStorageObject, ByVal Objects As TElDataStorageObjectList)
    Sub List(ByVal Folder As TElGoogleDataStorageObject, ByVal Query As String, ByVal ShowFolders As Boolean, ByVal ShowDeleted As Boolean, ByVal OrderBy As TSBGoogleEntryOrder, ByVal Objects As TElDataStorageObjectList)
    Sub List(ByVal Query As String, ByVal Alt As String, ByVal Author As String, ByVal StartIndex As Long, ByVal MaxResults As Long, ByVal UpdatedMin As DateTime, ByVal UpdatedMax As DateTime, ByVal Category As String, ByVal Title As String, ByVal ExactTitle As Boolean, ByVal OpenedMin As DateTime, ByVal OpenedMax As DateTime, ByVal Owner As String, ByVal Writer As String, ByVal Reader As String, ByVal ShowFolders As Boolean, ByVal ShowDeleted As Boolean, ByVal OrderBy As TSBGoogleEntryOrder, ByVal Objects As TElDataStorageObjectList)
    Sub List(ByVal Folder As TElGoogleDataStorageObject, ByVal Query As String, ByVal Alt As String, ByVal Author As String, ByVal StartIndex As Long, ByVal MaxResults As Long, ByVal UpdatedMin As DateTime, ByVal UpdatedMax As DateTime, ByVal Category As String, ByVal Title As String, ByVal ExactTitle As Boolean, ByVal OpenedMin As DateTime, ByVal OpenedMax As DateTime, ByVal Owner As String, ByVal Writer As String, ByVal Reader As String, ByVal ShowFolders As Boolean, ByVal ShowDeleted As Boolean, ByVal OrderBy As TSBGoogleEntryOrder, ByVal Objects As TElDataStorageObjectList),
    Function List() As StringArray
    function List(ByVal Folder As TElGoogleDataStorageObject, ByVal Query As String, ByVal Alt As String, ByVal Author As String, ByVal StartIndex As Long, ByVal MaxResults As Long, ByVal UpdatedMin As DateTime, ByVal UpdatedMax As DateTime, ByVal Category As String, ByVal Title As String, ByVal ExactTitle As Boolean, ByVal OpenedMin As DateTime, ByVal OpenedMax As DateTime, ByVal Owner As String, ByVal Writer As String, ByVal Reader As String, ByVal ShowFolders As Boolean, ByVal ShowDeleted As Boolean, ByVal OrderBy As TSBGoogleEntryOrder) As StringArray

[Pascal]
    procedure List(Objects : TElDataStorageObjectList);
    procedure List(const Query : string; ShowFolders : boolean; ShowDeleted : boolean; OrderBy : TSBGoogleEntryOrder; Objects : TElDataStorageObjectList);
    procedure List(Folder : TElGoogleDataStorageObject; Objects : TElDataStorageObjectList);
    procedure List(Folder : TElGoogleDataStorageObject; const Query : string; ShowFolders : boolean; ShowDeleted : boolean; OrderBy : TSBGoogleEntryOrder; Objects : TElDataStorageObjectList);
    procedure List(const Query : string; const Alt : string; const Author : string; StartIndex : Int64; MaxResults : Int64; UpdatedMin, UpdatedMax : TDateTime; const Category : string; const Title : string; ExactTitle : boolean; OpenedMin, OpenedMax : TDateTime; const Owner : string; const Writer : string; const Reader : string; ShowFolders : boolean; ShowDeleted : boolean; OrderBy : TSBGoogleEntryOrder; Objects : TElDataStorageObjectList);
    procedure List(Folder : TElGoogleDataStorageObject; const Query : string; const Alt : string; const Author : string; StartIndex : Int64; MaxResults : Int64; UpdatedMin, UpdatedMax : TDateTime; const Category : string; const Title : string; ExactTitle : boolean; OpenedMin, OpenedMax : TDateTime; const Owner : string; const Writer : string; const Reader : string; ShowFolders : boolean; ShowDeleted : boolean; OrderBy : TSBGoogleEntryOrder; Objects : TElDataStorageObjectList);

[C++]
    not available

[PHP]
    not available

Parameters

  • Objects - contains queried objects.
  • Query - query according to which the objects should be selected.
  • Folder - folder which entries should be listed. If not specified, current folder is used.
  • ShowFolders - specifies, if folders should be shown in the list.
  • ShowDeleted - specifies, if deleted objects should be shown in the list.
  • OrderBy - specifies list ordering.
  • Alt - specifies the format of the feed to be returned. Consult Google Data API references for more details.
  • Author - specifies object's author. If empty, all authors will be selected.
  • StartIndex - search start index, if set to -1, starts from the first object.
  • MaxResults - specifies maximum number of queried objects. If set to -1, all objects will be selected.
  • UpdatedMin - minimum modification time.
  • UpdatedMax - maximum modification time.
  • OpenedMin - minimum last opening time.
  • OpenedMax - maximum last opening time.
  • Category - object's category.
  • Title - object's title.
  • ExactTitle - specifies whether the exact title match should be checked.
  • Owner - object's owner.
  • Writer - object's last writer.
  • Reader - object's last reader.

Values:

Return value

    Returns a list of titles of queried objects ordered as specified by OrderBy parameter.

Description

    Use this method to get a list of objects in the storage. Objects may be searched for by different criteria, such as object's Title or modification date (UpdatedMin and UpdatedMax parameters).

Discuss this help topic in SecureBlackbox Forum