BTNCardList Protocol Reference

Conforms to NSObject
Declared in BTNCardListProtocol.h

– cards required method

The list of cards currently added to the card system, in the order they can be displayed to the user.

- (NSArray<BTNCard*> *)cards

Return Value

An array of cards currently added to the card list.

Discussion

The list of cards currently added to the card system, in the order they can be displayed to the user.

Declared In

BTNCardListProtocol.h

– setCards: required method

Sets the cards to be maintained by the card list.

- (void)setCards:(NSArray<BTNCard*> *)cards

Parameters

cards

The array of cards.

Discussion

Sets the cards to be maintained by the card list.

Declared In

BTNCardListProtocol.h

– addCard: required method

Appends a card to the end of the current list of cards in the card system.

- (void)addCard:(BTNCard *)card

Parameters

card

The card to be added.

Discussion

Appends a card to the end of the current list of cards in the card system.

Declared In

BTNCardListProtocol.h

– insertCard:atIndex: required method

Inserts a card into the current list of cards in the card system at a specific index.

- (void)insertCard:(BTNCard *)card atIndex:(NSUInteger)index

Parameters

card

The card to be added.
index

The location in the current list of cards to insert the card.

Discussion

Inserts a card into the current list of cards in the card system at a specific index.

Declared In

BTNCardListProtocol.h

– cardForKey: required method

Returns the card in the current card system that matches the given key.

- (nullable BTNCard *)cardForKey:(id<NSObject>)key

Parameters

key

The key of the card to be returned.

Return Value

The card in the current card system that matches the given key.

Discussion

Returns the card in the current card system that matches the given key.

Keys are meant to be unique. If multiple cards match the given key, the first in the list that matches will be returned.

Declared In

BTNCardListProtocol.h

– replaceCardForKey:withCard: required method

Replaces the card in the current card system that matches the given key with a new card.

- (void)replaceCardForKey:(id<NSObject>)key withCard:(nullable BTNCard *)card

Parameters

key

The key of the card to be replaced.

Discussion

Replaces the card in the current card system that matches the given key with a new card.

Keys are meant to be unique. If multiple cards match the given key, the first in the list that matches will be replaced. If no cards match, no replacement will occur.

Declared In

BTNCardListProtocol.h

– removeCardForKey: required method

Removes the card in the current card system that matches the given key.

- (void)removeCardForKey:(id<NSObject>)key

Parameters

key

The key of the card to be removed.

Discussion

Removes the card in the current card system that matches the given key.

Keys are meant to be unique. If multiple cards match the given key, the first in the list that matches will be removed.

Declared In

BTNCardListProtocol.h

– removeAllCards required method

Removes all cards in the current card system.

- (void)removeAllCards

Discussion

Removes all cards in the current card system.

Declared In

BTNCardListProtocol.h