mirror of
https://github.com/vector-im/element-ios.git
synced 2024-09-30 00:02:47 +00:00
141 lines
4.6 KiB
Objective-C
141 lines
4.6 KiB
Objective-C
/*
|
|
Copyright 2017 OpenMarket Ltd
|
|
Copyright 2017 Vector Creations Ltd
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
*/
|
|
|
|
#import <MatrixKit/MatrixKit.h>
|
|
|
|
#import "ContactTableViewCell.h"
|
|
#import "RiotDesignValues.h"
|
|
|
|
@class ContactsTableViewController;
|
|
|
|
/**
|
|
`ContactsTableViewController` delegate.
|
|
*/
|
|
@protocol ContactsTableViewControllerDelegate <NSObject>
|
|
|
|
/**
|
|
Tells the delegate that the user selected a contact.
|
|
|
|
@param contactsTableViewController the `ContactsTableViewController` instance.
|
|
@param contact the selected contact.
|
|
*/
|
|
- (void)contactsTableViewController:(ContactsTableViewController *)contactsTableViewController didSelectContact:(MXKContact*)contact;
|
|
|
|
@end
|
|
|
|
/**
|
|
'ContactsTableViewController' instance is used to display/filter a list of contacts.
|
|
See 'ContactsTableViewController-inherited' object for example of use.
|
|
*/
|
|
@interface ContactsTableViewController : MXKViewController <UITableViewDelegate, UITableViewDataSource, UIGestureRecognizerDelegate>
|
|
{
|
|
@protected
|
|
// Section indexes
|
|
NSInteger searchInputSection;
|
|
NSInteger filteredLocalContactsSection;
|
|
NSInteger filteredMatrixContactsSection;
|
|
|
|
// The contact used to describe the current user.
|
|
MXKContact *userContact;
|
|
|
|
// Tell whether the non-matrix-enabled contacts must be hidden or not. NO by default.
|
|
BOOL hideNonMatrixEnabledContacts;
|
|
|
|
// Search results
|
|
NSString *currentSearchText;
|
|
NSMutableArray<MXKContact*> *filteredLocalContacts;
|
|
NSMutableArray<MXKContact*> *filteredMatrixContacts;
|
|
}
|
|
|
|
/**
|
|
Returns the `UINib` object initialized for a `ContactsTableViewController`.
|
|
|
|
@return The initialized `UINib` object or `nil` if there were errors during initialization
|
|
or the nib file could not be located.
|
|
*/
|
|
+ (UINib *)nib;
|
|
|
|
/**
|
|
Creates and returns a new `ContactsTableViewController` object.
|
|
|
|
@discussion This is the designated initializer for programmatic instantiation.
|
|
@return An initialized `ContactsTableViewController` object if successful, `nil` otherwise.
|
|
*/
|
|
+ (instancetype)contactsTableViewController;
|
|
|
|
/**
|
|
The Google Analytics Instance screen name (Default is "ContactsTable").
|
|
*/
|
|
@property (nonatomic) NSString *screenName;
|
|
|
|
/**
|
|
The contacts table view.
|
|
*/
|
|
@property (weak, nonatomic) IBOutlet UITableView *tableView;
|
|
|
|
/**
|
|
Tell whether the matrix id should be added by default in the matrix contact display name (NO by default).
|
|
If NO, the matrix id is added only to disambiguate the contact display names which appear several times.
|
|
*/
|
|
@property (nonatomic) BOOL forceMatrixIdInDisplayName;
|
|
|
|
/**
|
|
The type of standard accessory view the contact cells should use
|
|
Default is UITableViewCellAccessoryNone.
|
|
*/
|
|
@property (nonatomic) UITableViewCellAccessoryType contactCellAccessoryType;
|
|
|
|
/**
|
|
An image used to create a custom accessy view on the right side of the contact cells.
|
|
If set, use custom view. ignore accessoryType
|
|
*/
|
|
@property (nonatomic) UIImage *contactCellAccessoryImage;
|
|
|
|
/**
|
|
The dictionary of the ignored local contacts, the keys are their email. Empty by default.
|
|
*/
|
|
@property (nonatomic) NSMutableDictionary<NSString*, MXKContact*> *ignoredContactsByEmail;
|
|
|
|
/**
|
|
The dictionary of the ignored matrix contacts, the keys are their matrix identifier. Empty by default.
|
|
*/
|
|
@property (nonatomic) NSMutableDictionary<NSString*, MXKContact*> *ignoredContactsByMatrixId;
|
|
|
|
/**
|
|
Filter the contacts list, by keeping only the contacts who have the search pattern
|
|
as prefix in their display name, their matrix identifiers and/or their contact methods (emails, phones).
|
|
|
|
@param searchText the search pattern (nil to reset filtering).
|
|
@param forceReset tell whether the search request must be applied by ignoring the previous search result if any (use NO by default).
|
|
@param complete a block object called when the operation is complete.
|
|
*/
|
|
- (void)searchWithPattern:(NSString *)searchText forceReset:(BOOL)forceReset complete:(void (^)())complete;
|
|
|
|
/**
|
|
Refresh the contacts table display.
|
|
*/
|
|
- (void)refreshTableView;
|
|
|
|
/**
|
|
The delegate for the view controller.
|
|
*/
|
|
@property (nonatomic) id<ContactsTableViewControllerDelegate> contactsTableViewControllerDelegate;
|
|
|
|
- (IBAction)onCheckBoxTap:(UITapGestureRecognizer*)sender;
|
|
|
|
@end
|
|
|