1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
//! This file has been automatically generated by `objc2`'s `header-translator`.
//! DO NOT EDIT
use core::ptr::NonNull;
use objc2::__framework_prelude::*;
use objc2_foundation::*;
use crate::*;
extern_class!(
/// This class is used to read, update and modify records within the directory
///
/// This class is used to read, update and modify records within the directory. outError is optional parameter,
/// nil can be passed if error details are not needed.
///
/// See also [Apple's documentation](https://developer.apple.com/documentation/opendirectory/odrecord?language=objc)
#[unsafe(super(NSObject))]
#[derive(Debug, PartialEq, Eq, Hash)]
pub struct ODRecord;
);
extern_conformance!(
unsafe impl NSObjectProtocol for ODRecord {}
);
impl ODRecord {
extern_methods!(
/// Similar to calling -[ODNode setCredentials:] except credentials are only set for this particular
/// record's node
///
/// Sets the credentials if necessary on the ODNode referenced by this ODRecord. Very similar to
/// calling -[ODNode setCredentials:] except other records referencing the underlying node will not get
/// authenticated, therefore inadvertant changes cannot occur. If all records referencing a particular
/// node need to be updated, then use -[ODNode setCredentials:] on the original node instead. If the
/// node is already authenticated with the same name and password, it will be a NOOP call. The original
/// ODNode held by an ODRecord will be released when the credentials are changed for the connection
/// associated with the record. outError is optional parameter, nil can be passed if error details are not needed.
///
/// # Safety
///
/// - `in_username` might not allow `None`.
/// - `in_password` might not allow `None`.
/// - `out_error` might not allow `None`.
#[unsafe(method(setNodeCredentials:password:error:))]
#[unsafe(method_family = none)]
pub unsafe fn setNodeCredentials_password_error(
&self,
in_username: Option<&NSString>,
in_password: Option<&NSString>,
out_error: Option<&mut Option<Retained<NSError>>>,
) -> bool;
#[cfg(all(feature = "CFOpenDirectory", feature = "CFOpenDirectoryConstants"))]
/// Similar to calling -[ODNode setCredentialsWithRecordType:] except credentials are only set for this particular record's
/// node
///
/// Allows the caller to use other types of authentications that are available in OpenDirectory, that may
/// require response-request loops, etc. Not all OD plugins will support this call, look for
/// kODErrorCredentialsMethodNotSupported in outError. Same behavior as ODRecordSetNodeCredentials. outError
/// is optional parameter, nil can be passed if error details are not needed.
///
/// # Safety
///
/// - `in_record_type` might not allow `None`.
/// - `in_type` might not allow `None`.
/// - `in_items` generic should be of the correct type.
/// - `in_items` might not allow `None`.
/// - `out_items` generic should be of the correct type.
/// - `out_items` might not allow `None`.
/// - `out_context` should be of the correct type.
/// - `out_context` might not allow `None`.
/// - `out_error` might not allow `None`.
#[unsafe(method(setNodeCredentialsWithRecordType:authenticationType:authenticationItems:continueItems:context:error:))]
#[unsafe(method_family = none)]
pub unsafe fn setNodeCredentialsWithRecordType_authenticationType_authenticationItems_continueItems_context_error(
&self,
in_record_type: Option<&ODRecordType>,
in_type: Option<&ODAuthenticationType>,
in_items: Option<&NSArray>,
out_items: Option<&mut Option<Retained<NSArray>>>,
out_context: Option<&mut Option<Retained<AnyObject>>>,
out_error: Option<&mut Option<Retained<NSError>>>,
) -> bool;
/// Unsupported method.
///
/// Unsupported method.
///
/// # Safety
///
/// - `in_cache_name` might not allow `None`.
/// - `out_error` might not allow `None`.
#[deprecated]
#[unsafe(method(setNodeCredentialsUsingKerberosCache:error:))]
#[unsafe(method_family = none)]
pub unsafe fn setNodeCredentialsUsingKerberosCache_error(
&self,
in_cache_name: Option<&NSString>,
out_error: Option<&mut Option<Retained<NSError>>>,
) -> bool;
/// Returns a dictionary containing the password policy for the record if available.
///
/// Returns a dictionary containing the password policy for the record if available. If no policy for record
/// nil will be returned. outError is optional parameter, nil can be passed if error details are not needed.
///
/// # Safety
///
/// `out_error` might not allow `None`.
#[deprecated = "use effectivePoliciesAndReturnError"]
#[unsafe(method(passwordPolicyAndReturnError:))]
#[unsafe(method_family = none)]
pub unsafe fn passwordPolicyAndReturnError(
&self,
out_error: Option<&mut Option<Retained<NSError>>>,
) -> Option<Retained<NSDictionary>>;
/// Verifies the password provided is valid for the record
///
/// Verifies the password provided is valid for the record. outError is optional parameter, nil can be passed if
/// error details are not needed.
///
/// # Safety
///
/// - `in_password` might not allow `None`.
/// - `out_error` might not allow `None`.
#[unsafe(method(verifyPassword:error:))]
#[unsafe(method_family = none)]
pub unsafe fn verifyPassword_error(
&self,
in_password: Option<&NSString>,
out_error: Option<&mut Option<Retained<NSError>>>,
) -> bool;
#[cfg(all(feature = "CFOpenDirectory", feature = "CFOpenDirectoryConstants"))]
/// Allows use of other OpenDirectory types of authentications
///
/// Allows the caller to use other types of authentications that are available in OpenDirectory, that may
/// require response-request loops, etc. A bool with the result of the operation.
/// If it fails, outError can be checked for more specific error. Some ODNodes may not support the call
/// so an error code of kODErrorCredentialsMethodNotSupported may be returned. outError is optional
/// parameter, nil can be passed if error details are not needed.
///
/// # Safety
///
/// - `in_type` might not allow `None`.
/// - `in_items` generic should be of the correct type.
/// - `in_items` might not allow `None`.
/// - `out_items` generic should be of the correct type.
/// - `out_items` might not allow `None`.
/// - `out_context` should be of the correct type.
/// - `out_context` might not allow `None`.
/// - `out_error` might not allow `None`.
#[unsafe(method(verifyExtendedWithAuthenticationType:authenticationItems:continueItems:context:error:))]
#[unsafe(method_family = none)]
pub unsafe fn verifyExtendedWithAuthenticationType_authenticationItems_continueItems_context_error(
&self,
in_type: Option<&ODAuthenticationType>,
in_items: Option<&NSArray>,
out_items: Option<&mut Option<Retained<NSArray>>>,
out_context: Option<&mut Option<Retained<AnyObject>>>,
out_error: Option<&mut Option<Retained<NSError>>>,
) -> bool;
/// Changes the password for a record
///
/// Changes the password for a record. The oldPassword can be nil if password is being set assuming the appropriate
/// privileges are in place. outError is optional parameter, nil can be passed if error details are not needed.
///
/// # Safety
///
/// - `old_password` might not allow `None`.
/// - `new_password` might not allow `None`.
/// - `out_error` might not allow `None`.
#[unsafe(method(changePassword:toPassword:error:))]
#[unsafe(method_family = none)]
pub unsafe fn changePassword_toPassword_error(
&self,
old_password: Option<&NSString>,
new_password: Option<&NSString>,
out_error: Option<&mut Option<Retained<NSError>>>,
) -> bool;
/// Synchronizes the record from the Directory in order to get current data and/or commit pending changes
///
/// Synchronizes the record from the Directory in order to get current data. Any previously fetched attributes
/// will be re-fetch from the Directory. This will not re-fetch the entire record, unless the entire record
/// has been accessed. Additionally, any changes made to the record will be committed to the directory,
/// if the node does not do immediate commits. outError is optional parameter, nil can be passed if error details
/// are not needed.
///
/// # Safety
///
/// `out_error` might not allow `None`.
#[unsafe(method(synchronizeAndReturnError:))]
#[unsafe(method_family = none)]
pub unsafe fn synchronizeAndReturnError(
&self,
out_error: Option<&mut Option<Retained<NSError>>>,
) -> bool;
/// Type of the record.
///
/// The record type.
#[unsafe(method(recordType))]
#[unsafe(method_family = none)]
pub unsafe fn recordType(&self) -> Retained<NSString>;
/// Name of the record.
///
/// This is the official record name.
#[unsafe(method(recordName))]
#[unsafe(method_family = none)]
pub unsafe fn recordName(&self) -> Retained<NSString>;
/// Returns the attributes and values in the form of a key-value pair set.
///
/// Returns the attributes and values in the form of a key-value pair set for this record. The key is a
/// NSString of the attribute name (e.g., kODAttributeTypeRecordName, etc.) and the value is an NSArray
/// of either NSData or NSString depending on the type of data. Binary data will be returned as NSData.
/// If nil is passed, then all currently retrieved attributes will be returned. outError is optional parameter,
/// nil can be passed if error details are not needed.
///
/// # Safety
///
/// - `in_attributes` generic should be of the correct type.
/// - `in_attributes` might not allow `None`.
/// - `out_error` might not allow `None`.
#[unsafe(method(recordDetailsForAttributes:error:))]
#[unsafe(method_family = none)]
pub unsafe fn recordDetailsForAttributes_error(
&self,
in_attributes: Option<&NSArray>,
out_error: Option<&mut Option<Retained<NSError>>>,
) -> Option<Retained<NSDictionary>>;
#[cfg(all(feature = "CFOpenDirectory", feature = "CFOpenDirectoryConstants"))]
/// Returns an NSArray of NSString or NSData values of the attribute
///
/// Returns an NSArray of NSString or NSData depending on the type of data. Binary data will be
/// returned as NSData. outError is optional parameter, nil can be passed if error details are not needed.
///
/// # Safety
///
/// - `in_attribute` might not allow `None`.
/// - `out_error` might not allow `None`.
#[unsafe(method(valuesForAttribute:error:))]
#[unsafe(method_family = none)]
pub unsafe fn valuesForAttribute_error(
&self,
in_attribute: Option<&ODAttributeType>,
out_error: Option<&mut Option<Retained<NSError>>>,
) -> Option<Retained<NSArray>>;
#[cfg(all(feature = "CFOpenDirectory", feature = "CFOpenDirectoryConstants"))]
/// Will take a mixture of NSData or NSString or an NSArray of either type when setting the values of an attribute
///
/// Will take a mixture of NSData or NSString or an NSArray of either type when setting the values of an attribute.
/// outError is optional parameter, nil can be passed if error details are not needed.
///
/// # Safety
///
/// - `in_value_or_values` should be of the correct type.
/// - `in_value_or_values` might not allow `None`.
/// - `in_attribute` might not allow `None`.
/// - `out_error` might not allow `None`.
#[unsafe(method(setValue:forAttribute:error:))]
#[unsafe(method_family = none)]
pub unsafe fn setValue_forAttribute_error(
&self,
in_value_or_values: Option<&AnyObject>,
in_attribute: Option<&ODAttributeType>,
out_error: Option<&mut Option<Retained<NSError>>>,
) -> bool;
#[cfg(all(feature = "CFOpenDirectory", feature = "CFOpenDirectoryConstants"))]
/// Removes all the values for an attribute.
///
/// Removes all the values for an attribute. outError is optional parameter, nil can be passed if
/// error details are not needed.
///
/// # Safety
///
/// - `in_attribute` might not allow `None`.
/// - `out_error` might not allow `None`.
#[unsafe(method(removeValuesForAttribute:error:))]
#[unsafe(method_family = none)]
pub unsafe fn removeValuesForAttribute_error(
&self,
in_attribute: Option<&ODAttributeType>,
out_error: Option<&mut Option<Retained<NSError>>>,
) -> bool;
#[cfg(all(feature = "CFOpenDirectory", feature = "CFOpenDirectoryConstants"))]
/// Will add a value to an attribute
///
/// Will add a value to an attribute. Should be either NSData or NSString type. outError is optional
/// parameter, nil can be passed if error details are not needed.
///
/// # Safety
///
/// - `in_value` should be of the correct type.
/// - `in_value` might not allow `None`.
/// - `in_attribute` might not allow `None`.
/// - `out_error` might not allow `None`.
#[unsafe(method(addValue:toAttribute:error:))]
#[unsafe(method_family = none)]
pub unsafe fn addValue_toAttribute_error(
&self,
in_value: Option<&AnyObject>,
in_attribute: Option<&ODAttributeType>,
out_error: Option<&mut Option<Retained<NSError>>>,
) -> bool;
#[cfg(all(feature = "CFOpenDirectory", feature = "CFOpenDirectoryConstants"))]
/// Will remove a value from an attribute
///
/// Will remove a value from an attribute. Should be either NSData or NSString type. outError is optional
/// parameter, nil can be passed if error details are not needed.
///
/// # Safety
///
/// - `in_value` should be of the correct type.
/// - `in_value` might not allow `None`.
/// - `in_attribute` might not allow `None`.
/// - `out_error` might not allow `None`.
#[unsafe(method(removeValue:fromAttribute:error:))]
#[unsafe(method_family = none)]
pub unsafe fn removeValue_fromAttribute_error(
&self,
in_value: Option<&AnyObject>,
in_attribute: Option<&ODAttributeType>,
out_error: Option<&mut Option<Retained<NSError>>>,
) -> bool;
/// Deletes the record from the node and invalidates the record.
///
/// Deletes the record from the node and invalidates the record. The ODRecord should be
/// released after deletion. outError is optional parameter, nil can be passed if error details are not needed.
///
/// # Safety
///
/// `out_error` might not allow `None`.
#[unsafe(method(deleteRecordAndReturnError:))]
#[unsafe(method_family = none)]
pub unsafe fn deleteRecordAndReturnError(
&self,
out_error: Option<&mut Option<Retained<NSError>>>,
) -> bool;
/// This will copy any policies configured for the record.
///
/// This will copy any policies configured for the record.
///
/// # Safety
///
/// `error` might not allow `None`.
#[deprecated = "use accountPoliciesAndReturnError:"]
#[unsafe(method(policiesAndReturnError:))]
#[unsafe(method_family = none)]
pub unsafe fn policiesAndReturnError(
&self,
error: Option<&mut Option<Retained<NSError>>>,
) -> Option<Retained<NSDictionary>>;
/// This will copy any policies configured for the record.
///
/// This will copy any policies configured for the record.
///
/// # Safety
///
/// `error` might not allow `None`.
#[deprecated = "use authenticationAllowedAndReturnError: and similar methods"]
#[unsafe(method(effectivePoliciesAndReturnError:))]
#[unsafe(method_family = none)]
pub unsafe fn effectivePoliciesAndReturnError(
&self,
error: Option<&mut Option<Retained<NSError>>>,
) -> Option<Retained<NSDictionary>>;
/// This will return a dictionary of supported policies.
///
/// This will return a dictionary of supported policies, if appropriate, the value will be the maximum value allowed
/// for the policy in question. For example, if password history is available, it will state how much history is
/// supported.
///
/// # Safety
///
/// `error` might not allow `None`.
#[deprecated]
#[unsafe(method(supportedPoliciesAndReturnError:))]
#[unsafe(method_family = none)]
pub unsafe fn supportedPoliciesAndReturnError(
&self,
error: Option<&mut Option<Retained<NSError>>>,
) -> Option<Retained<NSDictionary>>;
/// This will set the policy for the record.
///
/// This will set the policy for the record. Policies are evaluated in combination with node-level policies.
///
/// # Safety
///
/// - `policies` generic should be of the correct type.
/// - `policies` might not allow `None`.
/// - `error` might not allow `None`.
#[deprecated = "use setAccountPolicies:error:"]
#[unsafe(method(setPolicies:error:))]
#[unsafe(method_family = none)]
pub unsafe fn setPolicies_error(
&self,
policies: Option<&NSDictionary>,
error: Option<&mut Option<Retained<NSError>>>,
) -> bool;
#[cfg(all(feature = "CFOpenDirectory", feature = "CFOpenDirectoryConstants"))]
/// This will set a specific policy setting for the record.
///
/// This will set a specific policy setting for the record.
///
/// # Safety
///
/// - `policy` might not allow `None`.
/// - `value` should be of the correct type.
/// - `value` might not allow `None`.
/// - `error` might not allow `None`.
#[deprecated = "use addAccountPolicy:toCategory:error:"]
#[unsafe(method(setPolicy:value:error:))]
#[unsafe(method_family = none)]
pub unsafe fn setPolicy_value_error(
&self,
policy: Option<&ODPolicyType>,
value: Option<&AnyObject>,
error: Option<&mut Option<Retained<NSError>>>,
) -> bool;
#[cfg(all(feature = "CFOpenDirectory", feature = "CFOpenDirectoryConstants"))]
/// This will remove a specific policy setting from the record.
///
/// This will remove a specific policy setting from the record.
///
/// # Safety
///
/// - `policy` might not allow `None`.
/// - `error` might not allow `None`.
#[deprecated = "use removeAccountPolicy:fromCategory:error:"]
#[unsafe(method(removePolicy:error:))]
#[unsafe(method_family = none)]
pub unsafe fn removePolicy_error(
&self,
policy: Option<&ODPolicyType>,
error: Option<&mut Option<Retained<NSError>>>,
) -> bool;
#[cfg(all(feature = "CFOpenDirectory", feature = "CFOpenDirectoryConstants"))]
/// This will add a specific policy to the specific category for the record.
///
/// This will add a specific policy to the specific category for the record.
/// The specified policy will be applied, in combination with any
/// node policies, to the specified record when policies are evaluated.
///
/// Parameter `policy`: a dictionary containing the specific policy to be added.
/// The dictionary may contain the following keys:
/// kODPolicyKeyIdentifier a required key identifying the policy.
/// kODPolicyKeyParameters an optional key containing a dictionary of
/// parameters that can be used for informational purposes or in
/// the policy format string.
/// kODPolicyKeyContent a required key specifying the policy,
/// from which a predicate will be created for evaluating
/// the policy.
///
/// Parameter `category`: a valid ODPolicyCategoryType to which the policy will be added.
///
/// Parameter `error`: an optional NSError reference for error details.
///
/// Returns: a BOOL which signifies if the policy addition succeeded, otherwise error is set.
///
/// # Safety
///
/// - `policy` generic should be of the correct type.
/// - `policy` might not allow `None`.
/// - `category` might not allow `None`.
/// - `error` might not allow `None`.
#[unsafe(method(addAccountPolicy:toCategory:error:))]
#[unsafe(method_family = none)]
pub unsafe fn addAccountPolicy_toCategory_error(
&self,
policy: Option<&NSDictionary>,
category: Option<&ODPolicyCategoryType>,
error: Option<&mut Option<Retained<NSError>>>,
) -> bool;
#[cfg(all(feature = "CFOpenDirectory", feature = "CFOpenDirectoryConstants"))]
/// This will remove a specific policy from the specific category for the record.
///
/// This will remove a specific policy from the specific category for the record.
///
/// Parameter `policy`: a dictionary containing the specific policy to be
/// removed, with the same format as described in addAccountPolicy.
///
/// Parameter `category`: a valid ODPolicyCategoryType from which the policy will be removed.
///
/// Parameter `error`: an optional NSError reference for error details.
///
/// Returns: a BOOL which signifies if the policy removal succeeded, otherwise error is set.
///
/// # Safety
///
/// - `policy` generic should be of the correct type.
/// - `policy` might not allow `None`.
/// - `category` might not allow `None`.
/// - `error` might not allow `None`.
#[unsafe(method(removeAccountPolicy:fromCategory:error:))]
#[unsafe(method_family = none)]
pub unsafe fn removeAccountPolicy_fromCategory_error(
&self,
policy: Option<&NSDictionary>,
category: Option<&ODPolicyCategoryType>,
error: Option<&mut Option<Retained<NSError>>>,
) -> bool;
/// This will set the policies for the record.
///
/// This will set the policies for the record, replacing any
/// existing policies. All of the policies in the set will be
/// applied to the record when policies are evaluated.
///
/// Parameter `policies`: a dictionary containing all of the policies to be set
/// for the node. The dictionary may contain the following keys:
/// kODPolicyCategoryAuthentication an optional key with a value
/// of an array of policy dictionaries that specify when
/// authentications should be allowed.
/// kODPolicyCategoryPasswordContent an optional key with a
/// value of an array of policy dictionaries the specify the
/// required content of passwords.
/// kODPolicyCategoryPasswordChange an optional key with a value
/// of an array of policy dictionaries that specify when
/// passwords are required to be changed.
///
/// Parameter `error`: an optional NSError reference for error details.
///
/// Returns: a BOOL which signifies if the policy set succeeded, otherwise error is set.
///
/// # Safety
///
/// - `policies` generic should be of the correct type.
/// - `policies` might not allow `None`.
/// - `error` might not allow `None`.
#[unsafe(method(setAccountPolicies:error:))]
#[unsafe(method_family = none)]
pub unsafe fn setAccountPolicies_error(
&self,
policies: Option<&NSDictionary>,
error: Option<&mut Option<Retained<NSError>>>,
) -> bool;
/// Returns a dictionary containing any policies configured for the record.
///
/// Returns a dictionary containing any policies configured for the record.
/// Does not include any policies set for the node.
///
/// Returns a dictionary containing any policies configured for the record.
///
/// Parameter `error`: an optional NSError reference for error details.
///
/// Returns: a NSDictionary containing all currently set policies. The
/// format of the dictionary is the same as described in
/// setAccountPolicies.
///
/// # Safety
///
/// `error` might not allow `None`.
#[unsafe(method(accountPoliciesAndReturnError:))]
#[unsafe(method_family = none)]
pub unsafe fn accountPoliciesAndReturnError(
&self,
error: Option<&mut Option<Retained<NSError>>>,
) -> Option<Retained<NSDictionary>>;
/// Determines if policies allow the account to authenticate.
///
/// Determines if policies allow the account to authenticate.
/// Authentication and password change policies are evaluated.
/// Record-level and node-level policies are evaluated in
/// combination, with record-level taking precedence over node-level
/// policies. The failure of any single policy will deny the
/// authentication.
///
/// This check is only definitive at the time it was requested. The
/// policy or the environment could change before the authentication
/// is actually requested. Errors from the authentication request
/// should be consulted.
///
/// It is not necessary to call this function when calling
/// verifyPassword or verifyPasswordExtended since those methods
/// perform the same policy evaluation.
///
///
/// Parameter `error`: an optional NSError reference for error details.
///
/// Returns: a bool which signifies if the authentication is allowed, otherwise error is set.
///
/// # Safety
///
/// `error` might not allow `None`.
#[unsafe(method(authenticationAllowedAndReturnError:))]
#[unsafe(method_family = none)]
pub unsafe fn authenticationAllowedAndReturnError(
&self,
error: Option<&mut Option<Retained<NSError>>>,
) -> bool;
/// Determines if policies allow the password change.
///
/// Determines if policies allow the password change. Password
/// content policies are evaluated. Record-level and node-level
/// policies are evaluated in combination, with record-level taking
/// precedence over node-level policies. The failure of any single
/// policy will deny the password change.
///
/// This check is only definitive at the time it was requested. The
/// policy or the environment could change before the password change
/// is actually requested. Errors from the password change request
/// should be consulted.
///
///
/// Parameter `newPassword`: contains the password to be evaluated.
///
/// Parameter `error`: an optional NSError reference for error details.
///
/// Returns: a BOOL which signifies if the password change is allowed, otherwise error is set.
///
/// # Safety
///
/// - `new_password` might not allow `None`.
/// - `error` might not allow `None`.
#[unsafe(method(passwordChangeAllowed:error:))]
#[unsafe(method_family = none)]
pub unsafe fn passwordChangeAllowed_error(
&self,
new_password: Option<&NSString>,
error: Option<&mut Option<Retained<NSError>>>,
) -> bool;
/// Determines if the password will expire within the specified time.
///
/// Determines if the password will expire (i.e. need to be changed)
/// between now and the specified number of seconds in the future.
/// Password change policies are evaluated. Record-level and
/// node-level policies are evaluated in combination, with
/// record-level taking precedence over node-level policies.
///
/// Parameter `willExpireIn`: the number of seconds from the current time to be
/// used as the upper-bound for the password expiration period.
///
/// Returns: a BOOL which signifies if the password will expire within the
/// specified time.
#[unsafe(method(willPasswordExpire:))]
#[unsafe(method_family = none)]
pub unsafe fn willPasswordExpire(&self, will_expire_in: u64) -> bool;
/// Determines if authentications will expire within the specified time.
///
/// Determines if authentications will expire (i.e. session and/or
/// account expires) between now and the specified number of seconds
/// in the future. Authentication policies are evaluated.
/// Record-level and node-level policies are evaluated in
/// combination, with record-level taking precedence over node-level
/// policies.
///
/// Parameter `willExpireIn`: the number of seconds from the current time to be
/// used as the upper-bound for the authentication expiration period.
///
/// Returns: a BOOL which signifies if authentications will expire within the
/// specified time.
#[unsafe(method(willAuthenticationsExpire:))]
#[unsafe(method_family = none)]
pub unsafe fn willAuthenticationsExpire(&self, will_expire_in: u64) -> bool;
/// Determines how many seconds until the password expires.
///
/// Determines how many seconds until the password expires (i.e.
/// needs changing). Password change policies are evaluated.
/// Record-level and node-level policies are evaluated in
/// combination, with record-level taking precedence over node-level
/// policies.
///
/// Returns: the number of seconds until the password expires. If multiple
/// policies will cause the password to expire, the soonest
/// expiration time is returned. If already expired,
/// kODExpirationTimeExpired is returned. If there are no password
/// change policies, kODExpirationTimeNeverExpires is returned.
#[unsafe(method(secondsUntilPasswordExpires))]
#[unsafe(method_family = none)]
pub unsafe fn secondsUntilPasswordExpires(&self) -> i64;
/// Determines how many seconds until authentications expire.
///
/// Determines how many seconds until authentications expire (i.e.
/// session and/or account expires). Authentication policies are
/// evaluated. Record-level and node-level policies are evaluated
/// in combination, with record-level taking precedence over
/// node-level policies.
///
/// Returns: the number of seconds until authentications expire. If multiple
/// policies will cause authentications to expire, the soonest
/// expiration time is returned. If already expired,
/// kODExpirationTimeExpired is returned. If there are no
/// authentication policies controlling expiration,
/// kODExpirationTimeNeverExpires is returned.
#[unsafe(method(secondsUntilAuthenticationsExpire))]
#[unsafe(method_family = none)]
pub unsafe fn secondsUntilAuthenticationsExpire(&self) -> i64;
);
}
/// Methods declared on superclass `NSObject`.
impl ODRecord {
extern_methods!(
#[unsafe(method(init))]
#[unsafe(method_family = init)]
pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>;
#[unsafe(method(new))]
#[unsafe(method_family = new)]
pub unsafe fn new() -> Retained<Self>;
);
}
/// ODRecordGroupExtensions.
///
/// Record extensions for checking and modifying group membership.
impl ODRecord {
extern_methods!(
/// Will add the record as a member of the group record
///
/// Will add the record as a member of the group record. An error will be returned if the record is not
/// a group record. Additionally, if the member record is not an appropriate type allowed as part of a group
/// an error will be returned. outError is optional parameter, nil can be passed if error details are not needed.
///
/// # Safety
///
/// - `in_record` might not allow `None`.
/// - `out_error` might not allow `None`.
#[unsafe(method(addMemberRecord:error:))]
#[unsafe(method_family = none)]
pub unsafe fn addMemberRecord_error(
&self,
in_record: Option<&ODRecord>,
out_error: Option<&mut Option<Retained<NSError>>>,
) -> bool;
/// Will remove the record as a member from the group record
///
/// Will remove the record as a member from the group record. An error will be returned if the record is not
/// a group record. Additionally, if the member record is not an appropriate type allowed as part of a group
/// an error will be returned. outError is optional parameter, nil can be passed if error details are not needed.
///
/// # Safety
///
/// - `in_record` might not allow `None`.
/// - `out_error` might not allow `None`.
#[unsafe(method(removeMemberRecord:error:))]
#[unsafe(method_family = none)]
pub unsafe fn removeMemberRecord_error(
&self,
in_record: Option<&ODRecord>,
out_error: Option<&mut Option<Retained<NSError>>>,
) -> bool;
/// Will use membership APIs to determine if inRecord is a member of the group
///
/// Will use membership APIs to determine if inRecord is a member of the group. If the receiving
/// object is not a group then NO will still be returned. outError is optional parameter, nil can be passed if
/// error details are not needed.
///
/// # Safety
///
/// - `in_record` might not allow `None`.
/// - `out_error` might not allow `None`.
#[unsafe(method(isMemberRecord:error:))]
#[unsafe(method_family = none)]
pub unsafe fn isMemberRecord_error(
&self,
in_record: Option<&ODRecord>,
out_error: Option<&mut Option<Retained<NSError>>>,
) -> bool;
);
}