Skip to content

Commit f1ce4d9

Browse files
author
Bess Sadler
committed
Adding code example to demonstrate how resumption tokens are used.
1 parent fa3a5f0 commit f1ce4d9

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

lib/oai/client/response.rb

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,24 @@
11
module OAI
2+
3+
# An OAI::Response contains entries and a resumption token. If a resumption token is present,
4+
# then you must use it to fetch the rest of the entries for your query. For example:
5+
# # List all records
6+
# i = 1
7+
# begin
8+
# response = client.list_records
9+
# while response.entries.size > 0
10+
# response.entries.each { |entry|
11+
# puts "<b>#{i}</b> #{entry.header.identifier}<br/>"
12+
# i +=1
13+
# }
14+
# token = response.resumption_token
15+
# response = client.list_records :resumption_token => token if token
16+
# end
17+
# rescue OAI::Exception => e
18+
# puts 'No records to process'
19+
# end
20+
# puts "Done processing #{i} records"
21+
222
class Response
323
include OAI::XPath
424
attr_reader :doc, :resumption_token

0 commit comments

Comments
 (0)