View on GitHub
Changes the ownership of a pending entry
@example With splatted entry ids
redis.xclaim('mystream', 'mygroup', 'consumer1', 3600000, '0-1', '0-2')
@example With arrayed entry ids
redis.xclaim('mystream', 'mygroup', 'consumer1', 3600000, %w[0-1 0-2])
@example With idle option
redis.xclaim('mystream', 'mygroup', 'consumer1', 3600000, %w[0-1 0-2], idle: 1000)
@example With time option
redis.xclaim('mystream', 'mygroup', 'consumer1', 3600000, %w[0-1 0-2], time: 1542866959000)
@example With retrycount option
redis.xclaim('mystream', 'mygroup', 'consumer1', 3600000, %w[0-1 0-2], retrycount: 10)
@example With force option
redis.xclaim('mystream', 'mygroup', 'consumer1', 3600000, %w[0-1 0-2], force: true)
@example With justid option
redis.xclaim('mystream', 'mygroup', 'consumer1', 3600000, %w[0-1 0-2], justid: true)
@param key [String] the stream key
@param group [String] the consumer group name
@param consumer [String] the consumer name
@param min_idle_time [Integer] the number of milliseconds
@param ids [Array<String>] one or multiple entry ids
@param opts [Hash] several options for `XCLAIM` command
@option opts [Integer] :idle the number of milliseconds as last time it was delivered of the entry
@option opts [Integer] :time the number of milliseconds as a specific Unix Epoch time
@option opts [Integer] :retrycount the number of retry counter
@option opts [Boolean] :force whether to create the pending entry to the pending entries list or not
@option opts [Boolean] :justid whether to fetch just an array of entry ids or not
@return [Hash{String => Hash}] the entries successfully claimed
@return [Array<String>] the entry ids successfully claimed if justid option is `true`