Skip to content

Commit 6cf9bb1

Browse files
committed
Update getting-started example ObjC SDK
1 parent 48b47c2 commit 6cf9bb1

File tree

325 files changed

+115171
-1132
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

325 files changed

+115171
-1132
lines changed

examples/getting-started/vendor/CouchbaseLite/CouchbaseLite.xcframework/Info.plist

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,12 @@
55
<key>AvailableLibraries</key>
66
<array>
77
<dict>
8+
<key>BinaryPath</key>
9+
<string>CouchbaseLite.framework/Versions/A/CouchbaseLite</string>
810
<key>DebugSymbolsPath</key>
911
<string>dSYMs</string>
1012
<key>LibraryIdentifier</key>
11-
<string>macos-arm64_x86_64</string>
13+
<string>ios-arm64_x86_64-maccatalyst</string>
1214
<key>LibraryPath</key>
1315
<string>CouchbaseLite.framework</string>
1416
<key>SupportedArchitectures</key>
@@ -17,9 +19,13 @@
1719
<string>x86_64</string>
1820
</array>
1921
<key>SupportedPlatform</key>
20-
<string>macos</string>
22+
<string>ios</string>
23+
<key>SupportedPlatformVariant</key>
24+
<string>maccatalyst</string>
2125
</dict>
2226
<dict>
27+
<key>BinaryPath</key>
28+
<string>CouchbaseLite.framework/CouchbaseLite</string>
2329
<key>DebugSymbolsPath</key>
2430
<string>dSYMs</string>
2531
<key>LibraryIdentifier</key>
@@ -37,10 +43,12 @@
3743
<string>simulator</string>
3844
</dict>
3945
<dict>
46+
<key>BinaryPath</key>
47+
<string>CouchbaseLite.framework/Versions/A/CouchbaseLite</string>
4048
<key>DebugSymbolsPath</key>
4149
<string>dSYMs</string>
4250
<key>LibraryIdentifier</key>
43-
<string>ios-arm64_x86_64-maccatalyst</string>
51+
<string>macos-arm64_x86_64</string>
4452
<key>LibraryPath</key>
4553
<string>CouchbaseLite.framework</string>
4654
<key>SupportedArchitectures</key>
@@ -49,11 +57,11 @@
4957
<string>x86_64</string>
5058
</array>
5159
<key>SupportedPlatform</key>
52-
<string>ios</string>
53-
<key>SupportedPlatformVariant</key>
54-
<string>maccatalyst</string>
60+
<string>macos</string>
5561
</dict>
5662
<dict>
63+
<key>BinaryPath</key>
64+
<string>CouchbaseLite.framework/CouchbaseLite</string>
5765
<key>DebugSymbolsPath</key>
5866
<string>dSYMs</string>
5967
<key>LibraryIdentifier</key>

examples/getting-started/vendor/CouchbaseLite/CouchbaseLite.xcframework/ios-arm64/CouchbaseLite.framework/Headers/CBLArray.h

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
// CBLArray.h
33
// CouchbaseLite
44
//
5-
// Copyright (c) 2017 Couchbase, Inc All rights reserved.
5+
// Copyright (c) 2024 Couchbase, Inc All rights reserved.
66
//
77
// Licensed under the Apache License, Version 2.0 (the "License");
88
// you may not use this file except in compliance with the License.
@@ -18,13 +18,13 @@
1818
//
1919

2020
#import <Foundation/Foundation.h>
21-
#import "CBLArrayFragment.h"
21+
#import <CouchbaseLite/CBLArrayFragment.h>
22+
2223
@class CBLBlob;
2324
@class CBLDictionary;
2425
@class CBLArray;
2526
@class CBLMutableArray;
2627

27-
2828
NS_ASSUME_NONNULL_BEGIN
2929

3030
/** CBLArray protocol defines a set of methods for reading array data. */
@@ -35,11 +35,11 @@ NS_ASSUME_NONNULL_BEGIN
3535

3636
/*
3737
Gets value at the given index. The object types are CBLBlob,
38-
CBLArray, CBLDictionary, NSNumber, or NSString based on the underlying
39-
data type; or nil if the value is nil.
38+
CBLArray, CBLDictionary, NSNumber, NSString, or NSNull based on
39+
the underlying data type.
4040
4141
@param index The index.
42-
@return The object or nil.
42+
@return The value or nil.
4343
*/
4444
- (nullable id) valueAtIndex: (NSUInteger)index;
4545

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
//
2+
// CBLArrayIndexConfiguration.h
3+
// CouchbaseLite
4+
//
5+
// Copyright (c) 2024 Couchbase, Inc All rights reserved.
6+
//
7+
// Licensed under the Apache License, Version 2.0 (the "License");
8+
// you may not use this file except in compliance with the License.
9+
// You may obtain a copy of the License at
10+
//
11+
// http://www.apache.org/licenses/LICENSE-2.0
12+
//
13+
// Unless required by applicable law or agreed to in writing, software
14+
// distributed under the License is distributed on an "AS IS" BASIS,
15+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16+
// See the License for the specific language governing permissions and
17+
// limitations under the License.
18+
//
19+
20+
#import <Foundation/Foundation.h>
21+
#import <CouchbaseLite/CBLIndexConfiguration.h>
22+
23+
NS_ASSUME_NONNULL_BEGIN
24+
25+
/**
26+
Configuration for indexing property values within nested arrays in documents,
27+
intended for use with the UNNEST query.
28+
*/
29+
30+
@interface CBLArrayIndexConfiguration : CBLIndexConfiguration
31+
32+
/**
33+
Path to the array, which can be nested.
34+
*/
35+
36+
@property (nonatomic, readonly) NSString* path;
37+
38+
/**
39+
The expressions representing the values within the array to be indexed.
40+
*/
41+
42+
@property (nonatomic, readonly, nullable) NSArray<NSString*>* expressions;
43+
44+
/**
45+
Initializes the configuration with paths to the nested array
46+
and the optional expressions for the values within the arrays to be indexed.
47+
@param path Path to the array, which can be nested to be indexed.
48+
@note Use "[]" to represent a property that is an array of each nested
49+
array level. For a single array or the last level array, the "[]" is optional.
50+
51+
For instance, use "contacts[].phones" to specify an array of phones within
52+
each contact.
53+
@param expressions An optional array of strings, where each string
54+
represents an expression defining the values within the array
55+
to be indexed. If the array specified by the path contains
56+
scalar values, this parameter can be null.
57+
58+
@return The CBLArrayIndexConfiguration object.
59+
*/
60+
61+
- (instancetype) initWithPath: (NSString*)path
62+
expressions: (nullable NSArray<NSString*>*)expressions;
63+
64+
@end
65+
66+
NS_ASSUME_NONNULL_END

examples/getting-started/vendor/CouchbaseLite/CouchbaseLite.xcframework/ios-arm64/CouchbaseLite.framework/Headers/CBLBasicAuthenticator.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
// CBLBasicAuthenticator.h
33
// CouchbaseLite
44
//
5-
// Copyright (c) 2017 Couchbase, Inc All rights reserved.
5+
// Copyright (c) 2024 Couchbase, Inc All rights reserved.
66
//
77
// Licensed under the Apache License, Version 2.0 (the "License");
88
// you may not use this file except in compliance with the License.
@@ -18,7 +18,7 @@
1818
//
1919

2020
#import <Foundation/Foundation.h>
21-
#import "CBLAuthenticator.h"
21+
#import <CouchbaseLite/CBLAuthenticator.h>
2222

2323
NS_ASSUME_NONNULL_BEGIN
2424

examples/getting-started/vendor/CouchbaseLite/CouchbaseLite.xcframework/ios-arm64/CouchbaseLite.framework/Headers/CBLCollection.h

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
// CBLCollection.h
33
// CouchbaseLite
44
//
5-
// Copyright (c) 2022 Couchbase, Inc All rights reserved.
5+
// Copyright (c) 2024 Couchbase, Inc All rights reserved.
66
//
77
// Licensed under the Apache License, Version 2.0 (the "License");
88
// you may not use this file except in compliance with the License.
@@ -17,10 +17,12 @@
1717
// limitations under the License.
1818
//
1919

20-
#import "CBLCollectionChangeObservable.h"
21-
#import "CBLIndexable.h"
22-
#import "CBLCollectionTypes.h"
20+
#import <Foundation/Foundation.h>
21+
#import <CouchbaseLite/CBLCollectionChangeObservable.h>
22+
#import <CouchbaseLite/CBLIndexable.h>
23+
#import <CouchbaseLite/CBLCollectionTypes.h>
2324

25+
@class CBLDatabase;
2426
@class CBLDocument;
2527
@class CBLDocumentChange;
2628
@class CBLDocumentFragment;
@@ -70,12 +72,18 @@ extern NSString* const kCBLDefaultCollectionName;
7072
*/
7173
@interface CBLCollection : NSObject<CBLCollectionChangeObservable, CBLIndexable, NSCopying>
7274

73-
/** Collection name.*/
75+
/** Collection's name.*/
7476
@property (readonly, nonatomic) NSString* name;
7577

76-
/** The scope of the collection. */
78+
/** Collection's fully qualified name in the '<scope-name>.<collection-name>' format. */
79+
@property (readonly, nonatomic) NSString* fullName;
80+
81+
/** Collection's scope. */
7782
@property (readonly, nonatomic) CBLScope* scope;
7883

84+
/** Collection's database. */
85+
@property (readonly, nonatomic) CBLDatabase* database;
86+
7987
#pragma mark - Document Management
8088

8189
/** The number of documents in the collection. */
@@ -166,7 +174,7 @@ extern NSString* const kCBLDefaultCollectionName;
166174
167175
@param document The document.
168176
@param error On return, the error if any.
169-
@return /True on success, false on failure.
177+
@return True on success, false on failure.
170178
*/
171179
- (BOOL) deleteDocument: (CBLDocument*)document error: (NSError**)error;
172180

examples/getting-started/vendor/CouchbaseLite/CouchbaseLite.xcframework/ios-arm64/CouchbaseLite.framework/Headers/CBLCollectionChange.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
// CBLCollectionChange.h
33
// CouchbaseLite
44
//
5-
// Copyright (c) 2022 Couchbase, Inc All rights reserved.
5+
// Copyright (c) 2024 Couchbase, Inc All rights reserved.
66
//
77
// Licensed under the Apache License, Version 2.0 (the "License");
88
// you may not use this file except in compliance with the License.

examples/getting-started/vendor/CouchbaseLite/CouchbaseLite.xcframework/ios-arm64/CouchbaseLite.framework/Headers/CBLCollectionChangeObservable.h

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
// CBLCollectionChangeObservable.h
33
// CouchbaseLite
44
//
5-
// Copyright (c) 2022 Couchbase, Inc All rights reserved.
5+
// Copyright (c) 2024 Couchbase, Inc All rights reserved.
66
//
77
// Licensed under the Apache License, Version 2.0 (the "License");
88
// you may not use this file except in compliance with the License.
@@ -17,8 +17,8 @@
1717
// limitations under the License.
1818
//
1919

20-
#import "CBLCollectionChange.h"
21-
#import "CBLListenerToken.h"
20+
#import <CouchbaseLite/CBLCollectionChange.h>
21+
#import <CouchbaseLite/CBLListenerToken.h>
2222

2323
NS_ASSUME_NONNULL_BEGIN
2424
/**

examples/getting-started/vendor/CouchbaseLite/CouchbaseLite.xcframework/ios-arm64/CouchbaseLite.framework/Headers/CBLCollectionConfiguration.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
// CBLCollectionConfiguration.h
33
// CouchbaseLite
44
//
5-
// Copyright (c) 2022 Couchbase, Inc All rights reserved.
5+
// Copyright (c) 2024 Couchbase, Inc All rights reserved.
66
//
77
// Licensed under the Apache License, Version 2.0 (the "License");
88
// you may not use this file except in compliance with the License.
@@ -18,7 +18,7 @@
1818
//
1919

2020
#import <Foundation/Foundation.h>
21-
#import "CBLReplicatorTypes.h"
21+
#import <CouchbaseLite/CBLReplicatorTypes.h>
2222

2323
@protocol CBLConflictResolver;
2424

examples/getting-started/vendor/CouchbaseLite/CouchbaseLite.xcframework/ios-arm64/CouchbaseLite.framework/Headers/CBLCollectionTypes.h

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
// CBLCollectionTypes.h
33
// CouchbaseLite
44
//
5-
// Copyright (c) 2022 Couchbase, Inc All rights reserved.
5+
// Copyright (c) 2024 Couchbase, Inc All rights reserved.
66
//
77
// Licensed under the Apache License, Version 2.0 (the "License");
88
// you may not use this file except in compliance with the License.
@@ -17,6 +17,7 @@
1717
// limitations under the License.
1818
//
1919

20+
#import <Foundation/Foundation.h>
2021

2122
NS_ASSUME_NONNULL_BEGIN
2223

0 commit comments

Comments
 (0)